Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

500 Lines or Less

github.com

Post reply on HN
Print view View original

61–70 of 70 posts

Re: 500 Lines or Less

#61

Post by marssaxman »

mjrbrennan wrote: post #53
marssaxman wrote: post #45

Earlier quoted context omitted.

I considered Github links to be essentially content-free noise for several years because I did not know about their "README.md" convention. I think that people who live and breathe github probably don't realize how confusing their interface can be to a newcomer.

You didn't think to just scroll down?

I didn't know to scroll to the bottom, as I had never used github and was unfamiliar with its interface. I thought it was basically just a prettier version of the classic auto-generated "index" page for a directory, so it didn't occur to me that there would be more to it than the file list if I scrolled down.

Re: 500 Lines or Less

#63

Post by exabrial »

voltagex_ wrote: post #57
exabrial wrote: post #49

How about a competition to see who can write the clearest code for the next guy, in minimal lines of code?

Sometimes optimising for the least lines of code leads to less clarity than being a bit more verbose and explaining yourself better. I still haven't quite worked out the code vs comments ratio.

Couldn't agree more.

Re: 500 Lines or Less

#64

Post by pc86 »

marssaxman wrote: post #61
mjrbrennan wrote: post #53

Earlier quoted context omitted.

You didn't think to just scroll down?

I didn't know to scroll to the bottom, as I had never used github and was unfamiliar with its interface. I thought it was basically just a prettier version of the classic auto-generated "index" page for a directory, so it didn't occur to me that there would be more to it than the file list if I scrolled down.

> I didn't know to scroll to the bottom

If only there was some sort of bar that could indicate your relative position on the page. Maybe in the same spot on all websites to make it easy to see. Maybe even part of the browser!

In all seriousness this seems much less a GitHub issue and much more about how well you computers.

Re: 500 Lines or Less

#65

Post by Karunamon »

rtpg wrote: post #60
avar wrote: post #31

Earlier quoted context omitted.

The first thing I looked through, the pedometer/ directory, has a project that itself may be Don't you think including huge external libraries like that defeats the spirit of showing things that are 500 lines or less?

I don't think so. Would you rule out things like the python standard library? Though external library size can be important, does it come into play when talking about your own code structure?

Only if you assume it to be bug free in a way that your code will never expose.

Re: 500 Lines or Less

#66

Post by marssaxman »

pc86 wrote: post #64
marssaxman wrote: post #61

Earlier quoted context omitted.

I didn't know to scroll to the bottom, as I had never used github and was unfamiliar with its interface. I thought it was basically just a prettier version of the classic auto-generated "index" page for a directory, so it didn't occur to me that there would be more to it than the file list if I scrolled down.

> I didn't know to scroll to the bottom If only there was some sort of bar that could indicate your relative position on the page. Maybe in the same spot on all websites to make it easy to see. Maybe even part of the browser! In all seriousness this seems much less a GitHub issue and much more about how well you computers.

It is an issue of expectations and affordances. If there's no clue that what's at the bottom is going to be different than what's at the top, and what you're seeing at the top is not giving you anything useful, why would you scroll further and waste your time seeing more of it? Perhaps for some people that is natural, but different people navigate unfamiliar spaces in different ways.

What you see when you open a github project page is a file directory. If you have no pre-existing reason to believe the page is something more than it appears to be, it's reasonable to believe that the page you're looking at is, in fact, just a file directory. There is nothing on the page which suggests that it also contains a readme file viewer, hidden underneath.

I didn't scroll because the directory structure suggested to me that one would navigate by digging around to see what was inside. After the first couple of times I tried this without getting anywhere, I wrote github off as a waste of time, and after that I simply closed such links immediately. It might have been easier to discover README.md from some later link with a smaller directory, where a smaller amount of scrolling down might have revealed it, but by then I was no longer looking.

Re: 500 Lines or Less

#67

Post by wagglycocks »

mjrbrennan wrote: post #53
marssaxman wrote: post #45

Earlier quoted context omitted.

I considered Github links to be essentially content-free noise for several years because I did not know about their "README.md" convention. I think that people who live and breathe github probably don't realize how confusing their interface can be to a newcomer.

You didn't think to just scroll down?

But ... why would I assume that the bottom of the page had meaning when the top did not?

You don't read all the way through the Time Cube page before coming to an idea about the contents.

Post reply on HN