Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve code readability in README #19

Closed
wants to merge 1 commit into from

Conversation

jgaskins
Copy link

The tabs display as 8-space indentation in the browser. This PR converts them to 2-space indents.

The tabs display as 8-space indentation in the browser. This commit converts them to 2-space indents.
@tarcieri
Copy link

The question of tabs strikes again.

@ioquatix this is just going to keep coming up until you give in 😜

@coveralls
Copy link

coveralls commented Aug 31, 2017

Coverage Status

Coverage remained the same at 98.881% when pulling f344639 on jgaskins:patch-1 into 91c7f65 on socketry:master.

@jgaskins
Copy link
Author

lol! I admit that I didn't even check the commit history or closed PRs before submitting this. To be honest, I personally subscribe to the Aaron Patterson school of thought regarding tabs v spaces, but project READMEs are almost exclusively consumed via GitHub, whose Markdown preview doesn't support sanitization of tabs into spaces AFAIK.

Since the Ruby convention is 2 spaces and Ruby has the most consistent programming-language ecosystem regarding tabs/spaces, this feels to me like a sensible change. :-)

@picatz
Copy link
Member

picatz commented Aug 31, 2017

This is hilarious.

@picatz
Copy link
Member

picatz commented Aug 31, 2017

Also: I totally support this PR being merged. I was thinking about doing this myself the other day while looking at it 😹

@ioquatix
Copy link
Member

I'd rather GitHub fix their rendering to honour .editorconfig than work around the issue. https://github.com/socketry/async/blob/master/.editorconfig

@picatz
Copy link
Member

picatz commented Aug 31, 2017

Where do you even make that PR though?

@ioquatix
Copy link
Member

ioquatix commented Sep 1, 2017

GitHub doesn't have an official place to report issues, except via the support email. Although, I've had a pretty good response working directly with GitHub developers to fix issues.

@picatz
Copy link
Member

picatz commented Sep 1, 2017

@ioquatix : GitHub doesn't have an official place to report issues

That's like... almost ironic. 😹

@ioquatix
Copy link
Member

ioquatix commented Sep 1, 2017

Yeah, there has been some attempts to make something, here is one of the more popular ones: https://github.com/isaacs/github but totally unofficial.

@tarcieri
Copy link

tarcieri commented Sep 1, 2017

@ioquatix until GitHub fixes the problem (if that ever even happens) perhaps it's worth taking the simpler measure of adjusting the whitespace so it isn't immediately off-putting to the overwhelming majority of Rubyists who look at it and find it off-putting?

Is the number of times this has come up not evidence that it's a problem? I think it's pretty clear I'm not the only one who looks at it and finds it to be "weird"

@ioquatix
Copy link
Member

I review - indentation may look odd to some, but it looks fine to me, it doesn't cause any line wrapping which would be more of a concern, I believe the solution here is for github to fix and respect the .editorconfig.

@ioquatix ioquatix closed this Jan 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants