aboutsummaryrefslogtreecommitdiff
path: root/spec/STYLE.md
diff options
context:
space:
mode:
authorIan Jackson <ijackson@chiark.greenend.org.uk>2023-11-08 14:39:58 +0000
committerIan Jackson <ijackson@chiark.greenend.org.uk>2023-11-08 14:39:58 +0000
commitfc5e39267bbbb2ce8daf735aa46321a2fd2ca5f2 (patch)
tree586c30b281e9f84d316827ce011ad8655d49ce97 /spec/STYLE.md
parent26f933382371b9caf066dc4a2e8f4c1422ae3000 (diff)
downloadtorspec-fc5e39267bbbb2ce8daf735aa46321a2fd2ca5f2.tar.gz
torspec-fc5e39267bbbb2ce8daf735aa46321a2fd2ca5f2.zip
Add note about semantic newlines to the style guide
Diffstat (limited to 'spec/STYLE.md')
-rw-r--r--spec/STYLE.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/spec/STYLE.md b/spec/STYLE.md
index 78b5c8a..c5b5ef1 100644
--- a/spec/STYLE.md
+++ b/spec/STYLE.md
@@ -58,6 +58,13 @@ them upstreamed to more project-wide guides, if they are suitable.
Make sure you have read [this part of the README](https://spec.torproject.org/index.html#how-to-edit-these-specifications)!
+We are moving towards using
+[semantic newlines](https://rhodesmill.org/brandon/2012/one-sentence-per-line/):
+put each thought, or sentence, or subclause, on its own line,
+in the Markdown source text.
+(This is not yet applied consistently,
+and we won't reject contributions that don't write that way.)
+
## Vocabulary
We use these terms freely: