procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Clarify wording about arguments in doc strings

Browse source 
* doc/lispref/tips.texi (Documentation Tips): Clarify "important
arguments".  (Bug#67217)
This commit is contained in:
Eli Zaretskii 2023-11-17 09:04:20 +02:00
parent c20ae7a30f
commit b4d990bd63
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/lispref/tips.texi
View file

@ -645,11 +645,11 @@ include before the first blank line so as to make this display useful.
@item @item
The first line should mention all the important arguments of the The first line should mention all the important arguments of the
function, and should mention them in the order that they are written function (in particular, the mandatory arguments), and should mention
in a function call. If the function has many arguments, then it is them in the order that they are written in a function call. If the
not feasible to mention them all in the first line; in that case, the function has many arguments, then it is not feasible to mention them
first line should mention the first few arguments, including the most all in the first line; in that case, the first line should mention the
important arguments. first few arguments, including the most important arguments.
@item @item
When a function's documentation string mentions the value of an argument When a function's documentation string mentions the value of an argument