; Clarify wording about arguments in doc strings

* doc/lispref/tips.texi (Documentation Tips): Clarify "important
arguments".  (Bug#67217)

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index edc16181d193fe45545282825437d25cedd56410..db9f64aa8a01ee177d13d975362bb66e24542526 100644 (file)
--- 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