diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2019-12-28 11:13:25 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2019-12-28 11:13:25 +0200 |
| commit | 32222fb34cc784f0cfc1716294818fd69233b06c (patch) | |
| tree | d422c228640d6088bda8e6227bc9abd45c95c09c /doc/lispref/functions.texi | |
| parent | 3434ac67b9ec6b1d19f1c5ebb7d23b0b62dadac9 (diff) | |
| download | emacs-32222fb34cc784f0cfc1716294818fd69233b06c.tar.gz | |
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/lispref/functions.texi')
| -rw-r--r-- | doc/lispref/functions.texi | 6 |
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 makes the alias itself obsolete, not the function or macro which it resolves to. -@defun make-obsolete obsolete-name current-name &optional when +@defun make-obsolete obsolete-name current-name when This function marks @var{obsolete-name} as obsolete. @var{obsolete-name} should be a symbol naming a function or macro, or an alias for a function or macro. @@ -2104,11 +2104,11 @@ should begin in lower case, and end with a period. It can also be @code{nil}, in which case the warning message provides no additional details. -If provided, @var{when} should be a string indicating when the function +The argument @var{when} should be a string indicating when the function was first made obsolete---for example, a date or a release number. @end defun -@defmac define-obsolete-function-alias obsolete-name current-name &optional when doc +@defmac define-obsolete-function-alias obsolete-name current-name when &optional doc This convenience macro marks the function @var{obsolete-name} obsolete and also defines it as an alias for the function @var{current-name}. It is equivalent to the following: |