comparison lisp/help-fns.el @ 93247:5fc9c77f2aea

(describe-function-1, describe-variable): If CURRENT-NAME is nil, don't end obsolescence info with semicolon.
author Juanma Barranquero <lekktu@gmail.com>
date Wed, 26 Mar 2008 14:49:15 +0000
parents 53d5f10d34bc
children 553dfbccecfa
comparison
equal deleted inserted replaced
93246:6ac54c43b7ca 93247:5fc9c77f2aea
419 (high (help-highlight-arguments use doc))) 419 (high (help-highlight-arguments use doc)))
420 (let ((fill-begin (point))) 420 (let ((fill-begin (point)))
421 (insert (car high) "\n") 421 (insert (car high) "\n")
422 (fill-region fill-begin (point))) 422 (fill-region fill-begin (point)))
423 (setq doc (cdr high)))) 423 (setq doc (cdr high))))
424 (let ((obsolete (and 424 (let* ((obsolete (and
425 ;; function might be a lambda construct. 425 ;; function might be a lambda construct.
426 (symbolp function) 426 (symbolp function)
427 (get function 'byte-obsolete-info)))) 427 (get function 'byte-obsolete-info)))
428 (use (car obsolete)))
428 (when obsolete 429 (when obsolete
429 (princ "\nThis function is obsolete") 430 (princ "\nThis function is obsolete")
430 (when (nth 2 obsolete) 431 (when (nth 2 obsolete)
431 (insert (format " since %s" (nth 2 obsolete)))) 432 (insert (format " since %s" (nth 2 obsolete))))
432 (insert ";\n" 433 (insert (cond ((stringp use) (concat ";\n" use))
433 (if (stringp (car obsolete)) (car obsolete) 434 (use (format ";\nuse `%s' instead." use))
434 (if (null (car obsolete)) "" 435 (t "."))
435 (format "use `%s' instead." (car obsolete)))) 436 "\n"))
436 "\n"))
437 (insert "\n" 437 (insert "\n"
438 (or doc "Not documented."))))))) 438 (or doc "Not documented.")))))))
439 439
440 440
441 ;; Variables 441 ;; Variables
638 638
639 (let* ((alias (condition-case nil 639 (let* ((alias (condition-case nil
640 (indirect-variable variable) 640 (indirect-variable variable)
641 (error variable))) 641 (error variable)))
642 (obsolete (get variable 'byte-obsolete-variable)) 642 (obsolete (get variable 'byte-obsolete-variable))
643 (use (car obsolete))
643 (safe-var (get variable 'safe-local-variable)) 644 (safe-var (get variable 'safe-local-variable))
644 (doc (or (documentation-property variable 'variable-documentation) 645 (doc (or (documentation-property variable 'variable-documentation)
645 (documentation-property alias 'variable-documentation))) 646 (documentation-property alias 'variable-documentation)))
646 (extra-line nil)) 647 (extra-line nil))
647 ;; Add a note for variables that have been make-var-buffer-local. 648 ;; Add a note for variables that have been make-var-buffer-local.
659 660
660 (when obsolete 661 (when obsolete
661 (setq extra-line t) 662 (setq extra-line t)
662 (princ " This variable is obsolete") 663 (princ " This variable is obsolete")
663 (if (cdr obsolete) (princ (format " since %s" (cdr obsolete)))) 664 (if (cdr obsolete) (princ (format " since %s" (cdr obsolete))))
664 (princ ";\n ") 665 (princ (cond ((stringp use) (concat ";\n " use))
665 (princ (if (stringp (car obsolete)) (car obsolete) 666 (use (format ";\n use `%s' instead." (car obsolete)))
666 (if (null (car obsolete)) "" 667 (t ".")))
667 (format "use `%s' instead." (car obsolete)))))
668 (terpri)) 668 (terpri))
669 (when safe-var 669 (when safe-var
670 (setq extra-line t) 670 (setq extra-line t)
671 (princ " This variable is safe as a file local variable ") 671 (princ " This variable is safe as a file local variable ")
672 (princ "if its value\n satisfies the predicate ") 672 (princ "if its value\n satisfies the predicate ")