You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It is mostly a matter of style; the biggest issue with mixed convention is that it pollutes the git history when a file changes conventions due to someone's personal preferences or IDE's auto-formatting.
If we want consistent hard line wraps, would need to decide on a character limit, or a semantic limit.
My preference is for soft line wrapping, which seems to be most of the current source, or semantic wrapping.
The text was updated successfully, but these errors were encountered:
By starting a new line at the end of each sentence, and splitting sentences themselves
at natural breaks between clauses,
a text file becomes far easier to edit and version control.
I personally am of the opinion that enforcing one sentence per line is advantageous.
This forces clean line differences when changing the source text and makes it easier to review changes.
Additionally, it ensures that a changed line corresponds to changing (at most) a single sentence.
This makes it easier as a group to see what changed between commits
and to point to specific lines where content has changed in the source.
See #317 and #317 (comment). Related to #69. Doesn't need to be strictly enforced, but could be just noted as recommended style in the README.
The current
.md
source appears to be a mix of files with hard/semantic line wraps(e.g. 1 sentence per line) like https://github.com/argonne-lcf/user-guides/blob/main/docs/polaris/data-science-workflows/python.md, or mostly no line wraps like https://github.com/argonne-lcf/user-guides/blob/main/docs/polaris/running-jobs.md, or files that switch between conventions internally https://github.com/argonne-lcf/user-guides/blob/main/docs/aurora/data-management/daos/daos-overview.md .
It is mostly a matter of style; the biggest issue with mixed convention is that it pollutes the git history when a file changes conventions due to someone's personal preferences or IDE's auto-formatting.
If we want consistent hard line wraps, would need to decide on a character limit, or a semantic limit.
My preference is for soft line wrapping, which seems to be most of the current source, or semantic wrapping.
The text was updated successfully, but these errors were encountered: