]> git.eshelyaron.com Git - emacs.git/commitdiff
(make-obsolete): Doc fix.
authorGlenn Morris <rgm@gnu.org>
Thu, 28 Feb 2008 03:47:59 +0000 (03:47 +0000)
committerGlenn Morris <rgm@gnu.org>
Thu, 28 Feb 2008 03:47:59 +0000 (03:47 +0000)
lisp/emacs-lisp/byte-run.el

index 33a3f06d4e6f124dbcbf29a228e364daa66f5d2d..855111b9f9b3bd4690e0a8353f6fb1f8e9fc6786 100644 (file)
@@ -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: ")