aboutsummaryrefslogtreecommitdiffstats
path: root/admin/notes/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'admin/notes/documentation')
-rw-r--r--admin/notes/documentation49
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.
113In those cases, the user might have trouble figuring out how to use 113In those cases, the user might have trouble figuring out how to use
114the old version without some sort of help. 114the 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'.
117https://lists.gnu.org/r/emacs-devel/2012-02/msg00649.html 118https://lists.gnu.org/r/emacs-devel/2012-02/msg00649.html
119
120
121** etc/NEWS style rules
122
123Any change that matters to end-users should have an entry in etc/NEWS.
124This is not intended as reference of design decisions or interfaces.
125
126*** Each NEWS entry starts with a heading that summarizes the entry.
127It takes just one line, and will finish with a period. Section
128headings, which are one level up from entry headings, are not full
129sentences. First-level headings are broad categories, and the other
130section headings are the names of Emacs features. Don't use Lisp
131symbols for section headings. E.g. "Random mode" not "'random-mode'".
132
133*** All new, changed or obsoleted user options and commands are documented.
134Document the default value or the argument list, respectively.
135
136If a user option or command is obsoleted or changes the default value /
137argument list, document how to keep the previous behavior.
138
139Document further new, changed or obsoleted variables and functions, if
140they are relevant for package authors.
141
142*** Lisp symbols, Lisp forms and and key sequences are quoted 'like-this'.
143This 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
145follow this rule, like 'TAB' or ':type'. Exception: the symbols t and
146nil are not quoted.
147
148Arguments of a function are written in capital letters LIKE-THIS, and they
149are not quoted.
150
151If Lisp forms are written in a line of its own, they are not quoted.
152Separate these lines from the previous and following text by an empty
153line. Indent them with a width of 4 spaces.
154
155*** File names, buffer names, process names are strings.
156Quote them with quotation marks "like this". Exception: Lisp file names
157like 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.
164Call 'emacs-news-view-mode'. Lisp symbols and Info manual links shall
165be decorated, and clicking on them shall lead to the respective Help
166buffer or Info node.