diff options
| author | Nick Mathewson <nickm@torproject.org> | 2023-11-08 17:41:19 +0000 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2023-11-08 17:41:19 +0000 |
| commit | b567eaf9e6b84111ea019d7c89a39e671fbaaf13 (patch) | |
| tree | 08c81faa6cbd62abad6a427e8deea499b84a6e34 /spec | |
| parent | af15b59e4d9e944edc756c65c6a178d36952bbc1 (diff) | |
| parent | fc5e39267bbbb2ce8daf735aa46321a2fd2ca5f2 (diff) | |
| download | torspec-b567eaf9e6b84111ea019d7c89a39e671fbaaf13.tar.gz torspec-b567eaf9e6b84111ea019d7c89a39e671fbaaf13.zip | |
Merge branch 'newline' into 'main'
Add note about semantic newlines to the style guide
Closes #234
See merge request tpo/core/torspec!204
Diffstat (limited to 'spec')
| -rw-r--r-- | spec/STYLE.md | 7 |
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: |