Mercurial > emacs
comparison lispref/tips.texi @ 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 | 23a1cea22d13 |
children | 9928a29a3e80 |
comparison
equal
deleted
inserted
replaced
49959:264cc4bc5c57 | 49960:10a8aba3dfc7 |
---|---|
504 briefly answer the question, ``What does this value mean?'' | 504 briefly answer the question, ``What does this value mean?'' |
505 | 505 |
506 Don't limit the documentation string to one line; use as many lines as | 506 Don't limit the documentation string to one line; use as many lines as |
507 you need to explain the details of how to use the function or | 507 you need to explain the details of how to use the function or |
508 variable. Please use complete sentences for the rest of the text too. | 508 variable. Please use complete sentences for the rest of the text too. |
509 | |
510 @item | |
511 The first line should mention all the important arguments of the | |
512 function, and should mention them in the order that they are written | |
513 in a function call. If the function has many arguments, then it is | |
514 not feasible to mention them all in the first line; in that case, the | |
515 first line should mention the first few arguments, including the most | |
516 important arguments. | |
509 | 517 |
510 @item | 518 @item |
511 For consistency, phrase the verb in the first sentence of a function's | 519 For consistency, phrase the verb in the first sentence of a function's |
512 documentation string as an imperative--for instance, use ``Return the | 520 documentation string as an imperative--for instance, use ``Return the |
513 cons of A and B.'' in preference to ``Returns the cons of A and B@.'' | 521 cons of A and B.'' in preference to ``Returns the cons of A and B@.'' |