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

Improve documentation of actual arglist

Browse source 
* doc/lispref/functions.texi (Function Documentation): Advise
against using '(fn ARGLIST)' method of advertising a calling
convention when the old calling convention is deprecated.
(Bug#31191)
This commit is contained in:
Eli Zaretskii 2018-04-19 11:29:50 +03:00
parent ce0e253f48
commit f4c989427b
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/lispref/functions.texi
View file

@ -498,6 +498,14 @@ derived from the actual arguments of the function.
arguments written in a macro definition often do not correspond to the arguments written in a macro definition often do not correspond to the
way users think of the parts of the macro call. way users think of the parts of the macro call.
Do not use this feature if you want to deprecate the calling
convention and favor the one you advertise by the above specification.
Instead, use the @code{advertised-calling-convention} declaration
(@pxref{Declare Form}) or @code{set-advertised-calling-convention}
(@pxref{Obsolete Functions}), because these two will cause the byte
compiler emit a warning message when it compiles Lisp programs which
use the deprecated calling convention.
@node Function Names @node Function Names
@section Naming a Function @section Naming a Function
@cindex function definition @cindex function definition