emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] emacs-26 55e313f: ; * CONTRIBUTE: More suggestions for usi


From: Eli Zaretskii
Subject: [Emacs-diffs] emacs-26 55e313f: ; * CONTRIBUTE: More suggestions for using US English.
Date: Fri, 13 Oct 2017 05:05:55 -0400 (EDT)

branch: emacs-26
commit 55e313f7bea318f03bac0a2c9db362ed361961e6
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    ; * CONTRIBUTE: More suggestions for using US English.
---
 CONTRIBUTE | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/CONTRIBUTE b/CONTRIBUTE
index 78a2d51..8995bb3 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -82,8 +82,9 @@ Doc-strings should be updated together with the code.
 
 Think about whether your change requires updating the manuals.  If you
 know it does not, mark the NEWS entry with "---".  If you know
-that *all* the necessary documentation updates have been made, mark
-the entry with "+++".  Otherwise do not mark it.
+that *all* the necessary documentation updates have been made as part
+of your changes or those by others, mark the entry with "+++".
+Otherwise do not mark it.
 
 If your change requires updating the manuals to document new
 functions/commands/variables/faces, then use the proper Texinfo
@@ -92,6 +93,10 @@ command to index them; for instance, use @vindex for 
variables and
 
https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Predefined-Indices.html
 or run the shell command 'info "(texinfo)Predefined Indices"'.
 
+We prefer American English both in doc strings and in the manuals.
+That includes both spelling (e.g., "behavior", not "behaviour") and
+the convention of leaving 2 spaces between sentences.
+
 For more specific tips on Emacs's doc style, see
 
https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html
 Use 'checkdoc' to check for documentation errors before submitting a patch.
@@ -196,7 +201,8 @@ them right the first time, so here are guidelines for 
formatting them:
   the summary line should not end in a period).  See
   https://www.gnu.org/prep/standards/html_node/Comments.html
   or run 'info "(standards)Comments"'.  American English is preferred
-  in Emacs.
+  in Emacs; that includes spelling and leaving 2 blanks between
+  sentences.
 
   They are preserved indefinitely, and have a reasonable chance of
   being read in the future, so it's better that they have good



reply via email to

[Prev in Thread] Current Thread [Next in Thread]