Mercurial > emacs
changeset 49960:10a8aba3dfc7
First line of function doc string should mention the most important
args, in order.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Mon, 24 Feb 2003 16:48:54 +0000 |
| parents | 264cc4bc5c57 |
| children | 64f6bc336d1b |
| files | lispref/tips.texi |
| diffstat | 1 files changed, 8 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/tips.texi Mon Feb 24 16:47:27 2003 +0000 +++ b/lispref/tips.texi Mon Feb 24 16:48:54 2003 +0000 @@ -508,6 +508,14 @@ variable. Please use complete sentences for the rest of the text too. @item +The first line should mention all the important arguments of the +function, and should mention them in the order that they are written +in a function call. If the function has many arguments, then it is +not feasible to mention them all in the first line; in that case, the +first line should mention the first few arguments, including the most +important arguments. + +@item For consistency, phrase the verb in the first sentence of a function's documentation string as an imperative--for instance, use ``Return the cons of A and B.'' in preference to ``Returns the cons of A and B@.''