From afffe665734ed1daf8f509a6ffa14c2a941f45fb Mon Sep 17 00:00:00 2001 From: Andrew David Wong Date: Sat, 18 Feb 2017 23:18:11 -0800 Subject: [PATCH] Update Markdown conventions QubesOS/qubes-issues#1452 Closes QubesOS/qubes-issues#2639 --- basics_dev/doc-guidelines.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/basics_dev/doc-guidelines.md b/basics_dev/doc-guidelines.md index 1f407a09..348015b0 100644 --- a/basics_dev/doc-guidelines.md +++ b/basics_dev/doc-guidelines.md @@ -140,7 +140,11 @@ All the documentation is written in Markdown for maximum accessibility. When making contributions, please try to observe the following style conventions: * Use spaces instead of tabs. - * Hard wrap Markdown lines at 80 characters. + * Insert a newline at the end of each sentence. + * Rationale: This practice 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