diff options
| author | Eli Zaretskii | 2017-10-13 12:04:40 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2017-10-13 12:04:40 +0300 |
| commit | 55e313f7bea318f03bac0a2c9db362ed361961e6 (patch) | |
| tree | 1630da2020e6ae96c8f3f4009fae89b4e7f1399e | |
| parent | 622c675648e81d9c9267c26475dbcb617633c022 (diff) | |
| download | emacs-55e313f7bea318f03bac0a2c9db362ed361961e6.tar.gz emacs-55e313f7bea318f03bac0a2c9db362ed361961e6.zip | |
; * CONTRIBUTE: More suggestions for using US English.
| -rw-r--r-- | CONTRIBUTE | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE index 78a2d515cd5..8995bb3eec4 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE | |||
| @@ -82,8 +82,9 @@ Doc-strings should be updated together with the code. | |||
| 82 | 82 | ||
| 83 | Think about whether your change requires updating the manuals. If you | 83 | Think about whether your change requires updating the manuals. If you |
| 84 | know it does not, mark the NEWS entry with "---". If you know | 84 | know it does not, mark the NEWS entry with "---". If you know |
| 85 | that *all* the necessary documentation updates have been made, mark | 85 | that *all* the necessary documentation updates have been made as part |
| 86 | the entry with "+++". Otherwise do not mark it. | 86 | of your changes or those by others, mark the entry with "+++". |
| 87 | Otherwise do not mark it. | ||
| 87 | 88 | ||
| 88 | If your change requires updating the manuals to document new | 89 | If your change requires updating the manuals to document new |
| 89 | functions/commands/variables/faces, then use the proper Texinfo | 90 | functions/commands/variables/faces, then use the proper Texinfo |
| @@ -92,6 +93,10 @@ command to index them; for instance, use @vindex for variables and | |||
| 92 | https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Predefined-Indices.html | 93 | https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Predefined-Indices.html |
| 93 | or run the shell command 'info "(texinfo)Predefined Indices"'. | 94 | or run the shell command 'info "(texinfo)Predefined Indices"'. |
| 94 | 95 | ||
| 96 | We prefer American English both in doc strings and in the manuals. | ||
| 97 | That includes both spelling (e.g., "behavior", not "behaviour") and | ||
| 98 | the convention of leaving 2 spaces between sentences. | ||
| 99 | |||
| 95 | For more specific tips on Emacs's doc style, see | 100 | For more specific tips on Emacs's doc style, see |
| 96 | https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html | 101 | https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html |
| 97 | Use 'checkdoc' to check for documentation errors before submitting a patch. | 102 | 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: | |||
| 196 | the summary line should not end in a period). See | 201 | the summary line should not end in a period). See |
| 197 | https://www.gnu.org/prep/standards/html_node/Comments.html | 202 | https://www.gnu.org/prep/standards/html_node/Comments.html |
| 198 | or run 'info "(standards)Comments"'. American English is preferred | 203 | or run 'info "(standards)Comments"'. American English is preferred |
| 199 | in Emacs. | 204 | in Emacs; that includes spelling and leaving 2 blanks between |
| 205 | sentences. | ||
| 200 | 206 | ||
| 201 | They are preserved indefinitely, and have a reasonable chance of | 207 | They are preserved indefinitely, and have a reasonable chance of |
| 202 | being read in the future, so it's better that they have good | 208 | being read in the future, so it's better that they have good |