summaryrefslogtreecommitdiff
path: root/doc/lispref/tips.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/lispref/tips.texi')
-rw-r--r--doc/lispref/tips.texi10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index edc16181d19..db9f64aa8a0 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -645,11 +645,11 @@ include before the first blank line so as to make this display useful.
@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.
+function (in particular, the mandatory arguments), 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
When a function's documentation string mentions the value of an argument