Removed carriage returns #803
Conversation
|
What's the point of this? I find that what makes Markdown so brilliant is that it works so well when it is not rendered and just viewed as plain text in a text editor or in the terminal. In that environment, line-wrap at 80 characters is the standard and has been for 40 years. Removing these line breaks makes the document harder to navigate in those environments without adding anything I can think of to a rendered environment. As for providing some substance for my "cause", you have this and this Markdown style guide which both state that lines should break at 80 characters. I know most Markdown files in this repository don't follow this guideline, but I'd argue they should. 😃 |
|
I agree with your points, the main reason I did it was for consistency with the other files in the repo (I thought it was your standard for this repo). But I guess we should do the opposite then. |
|
Why is there no bullets displayed there: If I test on http://dillinger.io/ it looks fine. |
|
I would suspect that a carriage return is required. Not sure why it renders ok in GitHub and Dillinger and not on ReadTheDocs. |
While part of me agrees with this, I would also argue that most Markdown Editors, or at least the ones that I have played with, wrap the longer lines automatically, so it becomes less of an issue. I am a big fan of consistency though, so if we are going to do this, we should do it everywhere, and also document how to configure the more popular editors to automatically enforce this. |
|
Yea that's what I thought too first, that's why I added it sneakily in my last commit (the one that got rejected), but then I double checked in Dillinger to make sure and I saw it was displayed correctly so I thought it was rather odd. Are you aware of a better Markdown test tool that I could use ? |
|
@gep13 The problem isn't with "Markdown editors", it's with plain text editors or otherwise people reading and editing the files that don't even know the file is anything else than plain text. That scenario is possible because Markdown basically is plain text, but if we only set us up to "support Markdown editors", we make the plain text story more difficult without gaining anything, imho. I agree we should enforce the same policy across all |
None that I am aware of, no.
I am happy to let you take the lead on this one 😄 |
|
I think the best thing to do in order to wrap the text to 80 columns would be to use a tool / editor so that the result is consistent. VIM would be a pretty good standard tool imo.
Worked well for me. |
|
@dcorriveau-omniscient It's easy in Atom too. Just install the hard-wrap plugin, select the text you want to wrap and press ⌃⌥Y. |
|
@JakeGinnivan what are your thoughts on the above? I am happy to accept a PR is this work is completed. Thoughts? |
|
I have no probs with this going in :) |
|
@JakeGinnivan, awesome. @dcorriveau-omniscient, do you want to do a PR on this or do you want me to tackle it? Either way, we can collaborate. |
|
@asbjornu I only have converted one page to test the process so I don't really have a PR ready. You can tackle it :P |
|
@dcorriveau-omniscient Haha, okay. Want to close this PR then? |
|
Sure, thanks. |
Like this ?