]> git.eshelyaron.com Git - emacs.git/commitdiff
; * lisp/help-fns.el (help-fns-function-name): Doc fix.
authorEli Zaretskii <eliz@gnu.org>
Fri, 22 Mar 2024 07:54:37 +0000 (09:54 +0200)
committerEshel Yaron <me@eshelyaron.com>
Sun, 24 Mar 2024 14:20:13 +0000 (15:20 +0100)
(cherry picked from commit c1530a2e4973005633ebe00d447f1f3aa1200301)

lisp/help-fns.el

index 33988b4b0912408132af27cb4a3c2dd8024bc5e1..da1cc751da4ce1b3a726b8d204e087c34ff59018 100644 (file)
@@ -2488,7 +2488,14 @@ one of them returns non-nil."
 
 ;;;###autoload
 (defun help-fns-function-name (function)
-  "Return a short string representing FUNCTION."
+  "Return a short buttonized string representing FUNCTION.
+The string is propertized with a button; clicking on that
+provides further details about FUNCTION.
+FUNCTION can be a function, a built-in, a keyboard macro,
+or a compile function.
+This function is intended to be used to display various
+callable symbols in buffers in a way that allows the user
+to find out more details about the symbols."
   ;; FIXME: For kmacros, should we print the key-sequence?
   (cond
    ((symbolp function)