procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; * CONTRIBUTE: More suggestions for using US English.

Browse source
This commit is contained in:
Eli Zaretskii 2017-10-13 12:04:40 +03:00
parent 622c675648
commit 55e313f7be
1 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTE
View 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 Think about whether your change requires updating the manuals. If you
know it does not, mark the NEWS entry with "---". If you know know it does not, mark the NEWS entry with "---". If you know
that *all* the necessary documentation updates have been made, mark that *all* the necessary documentation updates have been made as part
the entry with "+++". Otherwise do not mark it. 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 If your change requires updating the manuals to document new
functions/commands/variables/faces, then use the proper Texinfo 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 https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Predefined-Indices.html
or run the shell command 'info "(texinfo)Predefined Indices"'. 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 For more specific tips on Emacs's doc style, see
https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html
Use 'checkdoc' to check for documentation errors before submitting a patch. 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 the summary line should not end in a period). See
https://www.gnu.org/prep/standards/html_node/Comments.html https://www.gnu.org/prep/standards/html_node/Comments.html
or run 'info "(standards)Comments"'. American English is preferred 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 They are preserved indefinitely, and have a reasonable chance of
being read in the future, so it's better that they have good being read in the future, so it's better that they have good