emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] Changes to emacs/lispref/tips.texi


From: Miles Bader
Subject: [Emacs-diffs] Changes to emacs/lispref/tips.texi
Date: Fri, 04 Apr 2003 01:23:25 -0500

Index: emacs/lispref/tips.texi
diff -c emacs/lispref/tips.texi:1.44 emacs/lispref/tips.texi:1.45
*** emacs/lispref/tips.texi:1.44        Tue Feb  4 09:47:54 2003
--- emacs/lispref/tips.texi     Mon Feb 24 11:48:54 2003
***************
*** 508,513 ****
--- 508,521 ----
  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 
address@hidden''




reply via email to

[Prev in Thread] Current Thread [Next in Thread]