From 7c48ab0b670efa400c6f875aa287a9f7516de5f2 Mon Sep 17 00:00:00 2001 From: ng0 Date: Mon, 6 Nov 2017 15:56:55 +0000 Subject: [PATCH] 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. --- doc/documentation/README.txt | 9 +++++++++ 1 file changed, 9 insertions(+) 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 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. -- 2.25.1