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

Markdown readability #223

Closed
toastal opened this Issue Mar 27, 2017 · 2 comments

Comments

3 participants
@toastal

toastal commented Mar 27, 2017

The spacing on these docs in these Markdown files make this project almost unreadable. I think you're trying to use tabs for alignment, when browsers often show them as 8 characters. And if you're using tabs for indentation, usually people use spaces for alignment. Regardless, set these documents to 2 or 4 spaces so people can read it online please.

What is this alignment, and how do I fix it

@jkphl jkphl self-assigned this May 30, 2017

@jkphl jkphl added the enhancement label May 30, 2017

@jkphl jkphl added this to the 2.x milestone May 30, 2017

@alexrussell

This comment has been minimized.

alexrussell commented Dec 18, 2017

I guess it's just a style choice but I have to agree with OP - the choice to align all the values of the config is actually really annoying (and error-prone!) to read.

And I mean that completely aside from the fact that sometimes the values aren't correctly aligned due to the presumably different tab widths (which is just an extra reason that this is not good to use).

@jkphl

This comment has been minimized.

Owner

jkphl commented Mar 17, 2018

Should be fixed as of 34d8c97

@jkphl jkphl closed this Mar 17, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment