]> git.eshelyaron.com Git - emacs.git/commitdiff
; * CONTRIBUTE: More suggestions for using US English.
authorEli Zaretskii <eliz@gnu.org>
Fri, 13 Oct 2017 09:04:40 +0000 (12:04 +0300)
committerEli Zaretskii <eliz@gnu.org>
Fri, 13 Oct 2017 09:04:40 +0000 (12:04 +0300)
CONTRIBUTE

index 78a2d515cd550488b9ad0716458360b1bc53d09c..8995bb3eec44c4cc798a551e317d46b60194035a 100644 (file)
@@ -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