From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 22 Mar 2024 07:54:37 +0000 (+0200)
Subject: ; * lisp/help-fns.el (help-fns-function-name): Doc fix.
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8a539661d9336240db0e1dcd3fefe15965bc04ec;p=emacs.git

; * lisp/help-fns.el (help-fns-function-name): Doc fix.

(cherry picked from commit c1530a2e4973005633ebe00d447f1f3aa1200301)
---

diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index 33988b4b091..da1cc751da4 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -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)