From: Eli Zaretskii Date: Fri, 17 Nov 2023 07:04:20 +0000 (+0200) Subject: ; Clarify wording about arguments in doc strings X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b4d990bd637;p=emacs.git ; 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 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