From a800ae9d1c43d9e4b8604e528f1478329ca4306c Mon Sep 17 00:00:00 2001 From: Andrew David Wong Date: Sun, 4 Feb 2018 23:15:22 -0600 Subject: [PATCH] Clarify one-sentence-per-line convention To avoid misunderstanding, e.g.: https://github.com/QubesOS/qubes-doc/pull/565#issuecomment-362980018 --- basics_user/doc-guidelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/basics_user/doc-guidelines.md b/basics_user/doc-guidelines.md index 27869f28..428dd376 100644 --- a/basics_user/doc-guidelines.md +++ b/basics_user/doc-guidelines.md @@ -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]) * URLs that appear inside code blocks (e.g., in comments and document templates) * 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). - * Rationale: This practice is most appropriate for source that consists primarily of natural language text. + * 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 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. * 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.