README: further specify point 4.
authorng0 <ng0@infotropique.org>
Mon, 6 Nov 2017 15:56:55 +0000 (15:56 +0000)
committerng0 <ng0@infotropique.org>
Mon, 6 Nov 2017 15:56:55 +0000 (15:56 +0000)
This means as a follow-up commit I'll have to revert some of the
Alice+Bob changes I made as an experiment.

doc/documentation/README.txt

index c3dda87c522d42388aad9d57cca271e836b629d0..b2a7815580df02399aadf6d5d7a69a3ef5f53d9c 100644 (file)
@@ -14,6 +14,15 @@ To be moved to an appropriate section of "how to write documentation" or
 
 4. Use neutral language and third person perspective in the text
 
+4.1 So, when you refer to a user in general or addressing the user,
+    refer to (1).
+4.1.1 Unsolved exceptions for canonical reasons:
+      When refering to Alice, use "she".
+      When refering to Bob, use "he".
+      These are long established examples and they
+      should either be replaced (avoid Alice and Bob
+      examples when you can) or followed.
+
 5. Use 2 spaces between sentences, so instead of:
 
      We do this and the other thing. This is done by foo.