diff options
Diffstat (limited to 'admin/notes/documentation')
| -rw-r--r-- | admin/notes/documentation | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/admin/notes/documentation b/admin/notes/documentation index 22bacb48b68..f6fa321b217 100644 --- a/admin/notes/documentation +++ b/admin/notes/documentation | |||
| @@ -113,5 +113,54 @@ is where a feature works _differently_ in the previous version. | |||
| 113 | In those cases, the user might have trouble figuring out how to use | 113 | In those cases, the user might have trouble figuring out how to use |
| 114 | the old version without some sort of help. | 114 | the old version without some sort of help. |
| 115 | 115 | ||
| 116 | |||
| 116 | ** To indicate possession, write Emacs's rather than Emacs'. | 117 | ** To indicate possession, write Emacs's rather than Emacs'. |
| 117 | https://lists.gnu.org/r/emacs-devel/2012-02/msg00649.html | 118 | https://lists.gnu.org/r/emacs-devel/2012-02/msg00649.html |
| 119 | |||
| 120 | |||
| 121 | ** etc/NEWS style rules | ||
| 122 | |||
| 123 | Any change that matters to end-users should have an entry in etc/NEWS. | ||
| 124 | This is not intended as reference of design decisions or interfaces. | ||
| 125 | |||
| 126 | *** Each NEWS entry starts with a heading that summarizes the entry. | ||
| 127 | It takes just one line, and will finish with a period. Section | ||
| 128 | headings, which are one level up from entry headings, are not full | ||
| 129 | sentences. First-level headings are broad categories, and the other | ||
| 130 | section headings are the names of Emacs features. Don't use Lisp | ||
| 131 | symbols for section headings. E.g. "Random mode" not "'random-mode'". | ||
| 132 | |||
| 133 | *** All new, changed or obsoleted user options and commands are documented. | ||
| 134 | Document the default value or the argument list, respectively. | ||
| 135 | |||
| 136 | If a user option or command is obsoleted or changes the default value / | ||
| 137 | argument list, document how to keep the previous behavior. | ||
| 138 | |||
| 139 | Document further new, changed or obsoleted variables and functions, if | ||
| 140 | they are relevant for package authors. | ||
| 141 | |||
| 142 | *** Lisp symbols, Lisp forms and and key sequences are quoted 'like-this'. | ||
| 143 | This results in clickable Lisp symbols when the NEWS file is visited via | ||
| 144 | 'view-emacs-news' ('C-h n'). Also single key names or keywords must | ||
| 145 | follow this rule, like 'TAB' or ':type'. Exception: the symbols t and | ||
| 146 | nil are not quoted. | ||
| 147 | |||
| 148 | Arguments of a function are written in capital letters LIKE-THIS, and they | ||
| 149 | are not quoted. | ||
| 150 | |||
| 151 | If Lisp forms are written in a line of its own, they are not quoted. | ||
| 152 | Separate these lines from the previous and following text by an empty | ||
| 153 | line. Indent them with a width of 4 spaces. | ||
| 154 | |||
| 155 | *** File names, buffer names, process names are strings. | ||
| 156 | Quote them with quotation marks "like this". Exception: Lisp file names | ||
| 157 | like subr.el, which are not quoted. | ||
| 158 | |||
| 159 | *** External program names are quoted with quotation marks like "this". | ||
| 160 | |||
| 161 | *** Manuals (Info pages) are referenced like "(elisp) Documentation Tips". | ||
| 162 | |||
| 163 | *** Prior pushing your changes, check the result. | ||
| 164 | Call 'emacs-news-view-mode'. Lisp symbols and Info manual links shall | ||
| 165 | be decorated, and clicking on them shall lead to the respective Help | ||
| 166 | buffer or Info node. | ||