mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-02 08:22:22 +00:00
Code Issues Releases Activity

Say what questions first line of doc string should answer.

Browse Source
This commit is contained in:
Richard M. Stallman 2001-11-13 02:20:53 +00:00
parent 9e7814d262
commit aa5dbf7b62
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lispref/tips.texi
View File

@ -489,9 +489,13 @@ apropos} displays just the first line, and if that line's contents don't
stand on their own, the result looks bad. In particular, start the
first line with a capital letter and end with a period.
The documentation string is not limited to one line; use as many lines
as you need to explain the details of how to use the function or
variable. Please use complete sentences in the additional lines.
For a function, the first line should briefly answer the question,
``What does this function do?'' For a variable, the first line should
briefly answer the question, ``What does this value mean?''
Don't limit the documentation string to one line; use as many lines as
you need to explain the details of how to use the function or
variable. Please use complete sentences for the rest of the text too.
@item
For consistency, phrase the verb in the first sentence of a function's