Mercurial > emacs

changeset 46042:0e4c329e9ab6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(describe-variable): Capitalize "not documented" message. (describe-function-1): Likewise. Also, document the obsolescence of the function, if applicable.
author Juanma Barranquero <lekktu@gmail.com>
date Thu, 27 Jun 2002 07:15:44 +0000
parents 53b3233b2574
children eb5a83484d86
files lisp/help-fns.el
diffstat 1 files changed, 11 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/help-fns.el	Thu Jun 27 07:14:52 2002 +0000
+++ b/lisp/help-fns.el	Thu Jun 27 07:15:44 2002 +0000
@@ -277,6 +277,15 @@
 	    ((stringp arglist)
 	     (princ arglist)
 	     (terpri))))
+    (let ((obsolete (get function 'byte-obsolete-info)))
+      (when obsolete
+        (terpri)
+        (princ "This function is obsolete")
+        (if (nth 2 obsolete) (princ (format " since %s" (nth 2 obsolete))))
+        (princ ".") (terpri)
+        (princ (if (stringp (car obsolete)) (car obsolete)
+                 (format "Use `%s' instead." (car obsolete))))
+        (terpri)))
     (let ((doc (documentation function)))
       (if doc
 	  (progn (terpri)
@@ -310,7 +319,7 @@
 			   (insert
 			    "[Missing arglist.  Please make a bug report.]\n")))
 		       (goto-char (point-max)))))
-	(princ "not documented")))))
+	(princ "Not documented.")))))
 
 
 ;; Variables
@@ -428,7 +437,7 @@
 			 (format "Use `%s' instead." (car obsolete))))
 		(terpri)))
 	    (let ((doc (documentation-property variable 'variable-documentation)))
-	      (princ (or doc "not documented as a variable.")))
+	      (princ (or doc "Not documented as a variable.")))
 	  
 	    ;; Make a link to customize if this variable can be customized.
 	    ;; Note, it is not reliable to test only for a custom-type property