Wrap lines at 80 characters #3616
Conversation
| @@ -52,7 +53,8 @@ your <code>_config.yml</code> file, with the addition of the preceding <code>_</ | |||
| </p> | |||
| </div> | |||
|
|
|||
| ### Step 3: Optionally render your collection's documents into independent files | |||
| ### Step 3: Optionally render your collection's documents into independent | |||
| files | |||
|
some weird indentation stuff and some formatting things go wrong. looks like we can't just broad-stroke it, have to be careful about what we change |
| @@ -32,7 +32,8 @@ class="flag">flags</code> (specified on the command-line) that control them. | |||
| <tr class="setting"> | |||
| <td> | |||
| <p class="name"><strong>Site Source</strong></p> | |||
| <p class="description">Change the directory where Jekyll will read files</p> | |||
| <p class="description">Change the directory where Jekyll will | |||
| read files</p> | |||
There was a problem hiding this comment.
I don't see how this should improve the readability?
Personally I would like to see it much more like this:
<p class="description">Change the directory where Jekyll will read files</p>or if the line has to be shorter, like this:
<p class="description">
Change the directory where Jekyll will read files
</p>Same comment for a few other occurrences.
There was a problem hiding this comment.
Yeah, I need to look more closely at the tables, code blocks, and other things inside of <pre> tags. My original intent was just to get everything under 80 characters for each line, but I can see there is more work that needs to be done.
There was a problem hiding this comment.
Paragraphs are a block tag, there must always be a new line after the <p> just so you know, those are just the unwritten style rules for HTML. If it's a block level element imply it's block level by giving it a new line, if it's inline then imply it's inline without a new line.
|
I know there are at least a few places where it's not possible to move lines around because it's inside of a code block or part of a long URL. A bit surprised that I missed it considering that these are just regular paragraphs and a header, but I'll look into it and try to shape things up. For the record, inline links are hideous. Did someone on the Core team make that decision or did this just happen organically over time because GitHub encourages long URLs in their Markdown docs? I would create a PR to "fix" that, but I imagine it would be massive as it touches almost everything inside of |
|
For what it's worth my vote will always go towards whatever makes the source of the docs more readable, so if you think it makes things more readable I think you should put it in if you like and see what everyone else thinks. It never hurts to improve readability in all places! |
|
I guess in principle we'd want this, but it isn't worth it at this point. Thank you though!! ❤️ |
No description provided.