/[emacs]/emacs/lispref/tips.texi
ViewVC logotype

Diff of /emacs/lispref/tips.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.39 by pj, Wed Oct 31 14:44:17 2001 UTC revision 1.40 by rms, Tue Nov 13 02:20:53 2001 UTC
# Line 489  apropos} displays just the first line, a Line 489  apropos} displays just the first line, a
489  stand on their own, the result looks bad.  In particular, start the  stand on their own, the result looks bad.  In particular, start the
490  first line with a capital letter and end with a period.  first line with a capital letter and end with a period.
491    
492  The documentation string is not limited to one line; use as many lines  For a function, the first line should briefly answer the question,
493  as you need to explain the details of how to use the function or  ``What does this function do?''  For a variable, the first line should
494  variable.  Please use complete sentences in the additional lines.  briefly answer the question, ``What does this value mean?''
495    
496    Don't limit the documentation string to one line; use as many lines as
497    you need to explain the details of how to use the function or
498    variable.  Please use complete sentences for the rest of the text too.
499    
500  @item  @item
501  For consistency, phrase the verb in the first sentence of a function's  For consistency, phrase the verb in the first sentence of a function's

Legend:
Removed from v.1.39  
changed lines
  Added in v.1.40

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26