aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii2019-12-28 11:13:25 +0200
committerEli Zaretskii2019-12-28 11:13:25 +0200
commit32222fb34cc784f0cfc1716294818fd69233b06c (patch)
treed422c228640d6088bda8e6227bc9abd45c95c09c /doc
parent3434ac67b9ec6b1d19f1c5ebb7d23b0b62dadac9 (diff)
downloademacs-32222fb34cc784f0cfc1716294818fd69233b06c.tar.gz
emacs-32222fb34cc784f0cfc1716294818fd69233b06c.zip
Fix documentation of define-obsolete-* functions
* doc/lispref/functions.texi (Obsolete Functions): Make documentation of functions that obsolete symbols match the advertised calling conventions. * lisp/emacs-lisp/byte-run.el (define-obsolete-function-alias) (define-obsolete-variable-alias, define-obsolete-face-alias): State in the doc strings that WHEN is a mandatory argument, to be consistent with the advertised calling convention. (Bug#38675)
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/functions.texi6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index 6157f9a535b..4307aab9268 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -2090,7 +2090,7 @@ alias for a function or macro can also be marked as obsolete; this
2090makes the alias itself obsolete, not the function or macro which it 2090makes the alias itself obsolete, not the function or macro which it
2091resolves to. 2091resolves to.
2092 2092
2093@defun make-obsolete obsolete-name current-name &optional when 2093@defun make-obsolete obsolete-name current-name when
2094This function marks @var{obsolete-name} as obsolete. 2094This function marks @var{obsolete-name} as obsolete.
2095@var{obsolete-name} should be a symbol naming a function or macro, or 2095@var{obsolete-name} should be a symbol naming a function or macro, or
2096an alias for a function or macro. 2096an alias for a function or macro.
@@ -2104,11 +2104,11 @@ should begin in lower case, and end with a period. It can also be
2104@code{nil}, in which case the warning message provides no additional 2104@code{nil}, in which case the warning message provides no additional
2105details. 2105details.
2106 2106
2107If provided, @var{when} should be a string indicating when the function 2107The argument @var{when} should be a string indicating when the function
2108was first made obsolete---for example, a date or a release number. 2108was first made obsolete---for example, a date or a release number.
2109@end defun 2109@end defun
2110 2110
2111@defmac define-obsolete-function-alias obsolete-name current-name &optional when doc 2111@defmac define-obsolete-function-alias obsolete-name current-name when &optional doc
2112This convenience macro marks the function @var{obsolete-name} obsolete 2112This convenience macro marks the function @var{obsolete-name} obsolete
2113and also defines it as an alias for the function @var{current-name}. 2113and also defines it as an alias for the function @var{current-name}.
2114It is equivalent to the following: 2114It is equivalent to the following: