# HG changeset patch
# User Richard M. Stallman <rms@gnu.org>
# Date 1046105334 0
# Node ID 10a8aba3dfc79dcd33130d4e669fccd0063574d0
# Parent  264cc4bc5c573ed5244069b06bd0b4aa10179802
First line of function doc string should mention the most important
args, in order.

diff -r 264cc4bc5c57 -r 10a8aba3dfc7 lispref/tips.texi
--- 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@.''