emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] master e1d42f8: * lisp/help-fns.el (describe-function-1):


From: Stefan Monnier
Subject: [Emacs-diffs] master e1d42f8: * lisp/help-fns.el (describe-function-1): Fix help-fns-test-dangling-alias.
Date: Fri, 20 Oct 2017 16:04:08 -0400 (EDT)

branch: master
commit e1d42f8f4a945669ff8b5159a569cb4b18f56e18
Author: Stefan Monnier <address@hidden>
Commit: Stefan Monnier <address@hidden>

    * lisp/help-fns.el (describe-function-1): Fix help-fns-test-dangling-alias.
---
 lisp/help-fns.el | 28 ++++++++++++++++++++--------
 1 file changed, 20 insertions(+), 8 deletions(-)

diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index 788c03e..e509ce6 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -561,6 +561,8 @@ FILE is the file where FUNCTION was probably defined."
     short))
 
 (defun help-fns--analyse-function (function)
+  ;; FIXME: Document/explain the differences between FUNCTION,
+  ;; REAL-FUNCTION, DEF, and REAL-DEF.
   "Return information about FUNCTION.
 Returns a list of the form (REAL-FUNCTION DEF ALIASED REAL-DEF)."
   (let* ((advised (and (symbolp function)
@@ -689,10 +691,15 @@ Returns a list of the form (REAL-FUNCTION DEF ALIASED 
REAL-DEF)."
                                 (point))))
   (terpri)(terpri)
 
-  (pcase-let ((`(,real-function ,def ,_aliased ,real-def)
-               (help-fns--analyse-function function))
-              (doc-raw (documentation function t))
-              (key-bindings-buffer (current-buffer)))
+  (pcase-let* ((`(,real-function ,def ,_aliased ,real-def)
+                (help-fns--analyse-function function))
+               (doc-raw (condition-case nil
+                            ;; FIXME: Maybe `documentation' should return nil
+                            ;; for invalid functions i.s.o. signaling an error.
+                            (documentation function t)
+                          ;; E.g. an alias for a not yet defined function.
+                          (invalid-function nil)))
+               (key-bindings-buffer (current-buffer)))
 
     ;; If the function is autoloaded, and its docstring has
     ;; key substitution constructs, load the library.
@@ -703,10 +710,15 @@ Returns a list of the form (REAL-FUNCTION DEF ALIASED 
REAL-DEF)."
 
     (help-fns--key-bindings function)
     (with-current-buffer standard-output
-      (let ((doc (help-fns--signature
-                  function doc-raw
-                  (if (subrp def) (indirect-function real-def) real-def)
-                  real-function key-bindings-buffer)))
+      (let ((doc (condition-case nil
+                     ;; FIXME: Maybe `help-fns--signature' should return `doc'
+                     ;; for invalid functions i.s.o. signaling an error.
+                     (help-fns--signature
+                      function doc-raw
+                      (if (subrp def) (indirect-function real-def) real-def)
+                      real-function key-bindings-buffer)
+                   ;; E.g. an alias for a not yet defined function.
+                   (invalid-function doc-raw))))
         (run-hook-with-args 'help-fns-describe-function-functions function)
         (insert "\n" (or doc "Not documented.")))
       (when (or (function-get function 'pure)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]