Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-10-01 01:25:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clarify one-sentence-per-line convention

Browse Source 
To avoid misunderstanding, e.g.:
https://github.com/QubesOS/qubes-doc/pull/565#issuecomment-362980018
This commit is contained in:
Andrew David Wong 2018-02-04 23:15:22 -06:00
parent 2786770412
commit a800ae9d1c
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
basics_user/doc-guidelines.md
View File

@ -156,8 +156,8 @@ When making contributions, please try to observe the following style conventions
* [News] posts (plain text is reproduced on the [mailing lists]) * [News] posts (plain text is reproduced on the [mailing lists])
* URLs that appear inside code blocks (e.g., in comments and document templates) * URLs that appear inside code blocks (e.g., in comments and document templates)
* Files like `README.md` and `CONTRIBUTING.md` * Files like `README.md` and `CONTRIBUTING.md`
* Insert a newline at the end of each sentence, except when the text will be reproduced outside of the Qubes website repo (see previous item for examples). * Insert a newline at, and only at, the end of each sentence, except when the text will be reproduced outside of the Qubes website repo (see previous item for examples).
* Rationale: This practice is most appropriate for source that consists primarily of natural language text. * Rationale: This practice results in one sentence per line, which is most appropriate for source that consists primarily of natural language text.
It results in the most useful diffs and facilitates translation into other languages while mostly preserving source readability. It results in the most useful diffs and facilitates translation into other languages while mostly preserving source readability.
* If appropriate, make numerals in numbered lists match between Markdown source and HTML output. * If appropriate, make numerals in numbered lists match between Markdown source and HTML output.
* Rationale: In the event that a user is required to read the Markdown source directly, this will make it easier to follow, e.g., numbered steps in a set of instructions. * Rationale: In the event that a user is required to read the Markdown source directly, this will make it easier to follow, e.g., numbered steps in a set of instructions.