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 /lisp/emacs-lisp | |
| parent | 3434ac67b9ec6b1d19f1c5ebb7d23b0b62dadac9 (diff) | |
| download | emacs-32222fb34cc784f0cfc1716294818fd69233b06c.tar.gz emacs-32222fb34cc784f0cfc1716294818fd69233b06c.tar.bz2 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 'lisp/emacs-lisp')
| -rw-r--r-- | lisp/emacs-lisp/byte-run.el | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el index 1115c096679..3737473b63b 100644 --- a/lisp/emacs-lisp/byte-run.el +++ b/lisp/emacs-lisp/byte-run.el @@ -378,8 +378,8 @@ is equivalent to the following two lines of code: \(defalias \\='old-fun \\='new-fun \"old-fun's doc.\") \(make-obsolete \\='old-fun \\='new-fun \"22.1\") -If provided, WHEN should be a string indicating when the function -was first made obsolete, for example a date or a release number. +WHEN should be a string indicating when the function was first +made obsolete, for example a date or a release number. See the docstrings of `defalias' and `make-obsolete' for more details." (declare (doc-string 4) @@ -423,8 +423,8 @@ dumped with Emacs). This is so that any user customizations are applied before the defcustom tries to initialize the variable (this is due to the way `defvaralias' works). -If provided, WHEN should be a string indicating when the variable -was first made obsolete, for example a date or a release number. +WHEN should be a string indicating when the variable was first +made obsolete, for example a date or a release number. For the benefit of Customize, if OBSOLETE-NAME has any of the following properties, they are copied to @@ -450,8 +450,8 @@ CURRENT-NAME, if it does not already have them: ;; It only really affects M-x describe-face output. (defmacro define-obsolete-face-alias (obsolete-face current-face when) "Make OBSOLETE-FACE a face alias for CURRENT-FACE and mark it obsolete. -If provided, WHEN should be a string indicating when the face -was first made obsolete, for example a date or a release number." +WHEN should be a string indicating when the face was first made +obsolete, for example a date or a release number." `(progn (put ,obsolete-face 'face-alias ,current-face) ;; Used by M-x describe-face. |