summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/byte-run.el
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2008-02-28 03:47:59 +0000
committerGlenn Morris <rgm@gnu.org>2008-02-28 03:47:59 +0000
commit584dcd8f486c03072280ae2b60eaf5683290e7b6 (patch)
treebc98045a31e12f15f515adc78402a702beebbbe4 /lisp/emacs-lisp/byte-run.el
parentd6a277d036cb6f163cd20edb1cd159dd0fa8e327 (diff)
downloademacs-584dcd8f486c03072280ae2b60eaf5683290e7b6.tar.gz
emacs-584dcd8f486c03072280ae2b60eaf5683290e7b6.tar.bz2
emacs-584dcd8f486c03072280ae2b60eaf5683290e7b6.zip
(make-obsolete): Doc fix.
Diffstat (limited to 'lisp/emacs-lisp/byte-run.el')
-rw-r--r--lisp/emacs-lisp/byte-run.el3
1 files changed, 2 insertions, 1 deletions
diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el
index 33a3f06d4e6..855111b9f9b 100644
--- a/lisp/emacs-lisp/byte-run.el
+++ b/lisp/emacs-lisp/byte-run.el
@@ -106,7 +106,8 @@ The return value of this function is not used."
(defun make-obsolete (obsolete-name current-name &optional when)
"Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
The warning will say that CURRENT-NAME should be used instead.
-If CURRENT-NAME is a string, that is the `use instead' message.
+If CURRENT-NAME is a string, that is the `use instead' message
+\(it should end with a period, and not start with a capital).
If provided, WHEN should be a string indicating when the function
was first made obsolete, for example a date or a release number."
(interactive "aMake function obsolete: \nxObsoletion replacement: ")