-
Notifications
You must be signed in to change notification settings - Fork 394
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
Switch documentation to not use line breaks at 80 cols #4
Comments
Closed
Closed
danepowell
added a commit
to danepowell/blt
that referenced
this issue
May 10, 2018
Update Drush aliases for BWD
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is a pet peeve of mine, since it makes updating documentation so unbearably hard—current docs are formatted thusly:
If I were to add a few words to the first line, I would then have to spend the next minute reflowing all the rest of the text in that paragraph so it all breaks at 80 cols.
Most modern editors have line wrapping capabilities, so editing text in markdown files should still be simple/easy to do even if each paragraph is on it's own line and is not broken at 80 characters.
This will also make documentation PRs much better, since only individual text changes need to be tracked, and not line-by-line reflows. For example, see this PR: https://github.com/acquia/bolt/pull/3/files#diff-23d3084f68a11bf46e7e79b8892be209L125 — it looks like that whole paragraph was changed, when in reality only one line was changed, but all the lines had changes because of the reflow.
The text was updated successfully, but these errors were encountered: