diff options
author | ng0 <ng0@infotropique.org> | 2017-11-06 15:56:55 +0000 |
---|---|---|
committer | ng0 <ng0@infotropique.org> | 2017-11-06 15:56:55 +0000 |
commit | 7c48ab0b670efa400c6f875aa287a9f7516de5f2 (patch) | |
tree | ffedc827efe0e7325190927bc2815d8b3c74b550 /doc | |
parent | 4540ee757ce8b8242b4f772755000ff6003db23e (diff) | |
download | gnunet-7c48ab0b670efa400c6f875aa287a9f7516de5f2.tar.gz gnunet-7c48ab0b670efa400c6f875aa287a9f7516de5f2.zip |
README: further specify point 4.
This means as a follow-up commit I'll have to revert some of the
Alice+Bob changes I made as an experiment.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/documentation/README.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/documentation/README.txt b/doc/documentation/README.txt index c3dda87c5..b2a781558 100644 --- a/doc/documentation/README.txt +++ b/doc/documentation/README.txt | |||
@@ -14,6 +14,15 @@ To be moved to an appropriate section of "how to write documentation" or | |||
14 | 14 | ||
15 | 4. Use neutral language and third person perspective in the text | 15 | 4. Use neutral language and third person perspective in the text |
16 | 16 | ||
17 | 4.1 So, when you refer to a user in general or addressing the user, | ||
18 | refer to (1). | ||
19 | 4.1.1 Unsolved exceptions for canonical reasons: | ||
20 | When refering to Alice, use "she". | ||
21 | When refering to Bob, use "he". | ||
22 | These are long established examples and they | ||
23 | should either be replaced (avoid Alice and Bob | ||
24 | examples when you can) or followed. | ||
25 | |||
17 | 5. Use 2 spaces between sentences, so instead of: | 26 | 5. Use 2 spaces between sentences, so instead of: |
18 | 27 | ||
19 | We do this and the other thing. This is done by foo. | 28 | We do this and the other thing. This is done by foo. |