diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2023-11-17 09:04:20 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2023-11-17 09:04:20 +0200 |
| commit | b4d990bd63724bcaf346b0b21ff63ff724a41815 (patch) | |
| tree | df4a7626e0c1775713c2b1018cc109a622dfa5d7 /doc/lispref | |
| parent | c20ae7a30fb012402be41b6fbfb45318005a09d7 (diff) | |
| download | emacs-b4d990bd63724bcaf346b0b21ff63ff724a41815.tar.gz emacs-b4d990bd63724bcaf346b0b21ff63ff724a41815.tar.bz2 emacs-b4d990bd63724bcaf346b0b21ff63ff724a41815.zip | |
; Clarify wording about arguments in doc strings
* doc/lispref/tips.texi (Documentation Tips): Clarify "important
arguments". (Bug#67217)
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/tips.texi | 10 |
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 |