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

This commit is contained in:
Eli Zaretskii 2024-03-22 09:54:37 +02:00
parent 0c321ddbd3
commit c1530a2e49

View file

@ -2465,7 +2465,14 @@ one of them returns non-nil."
;;;###autoload ;;;###autoload
(defun help-fns-function-name (function) (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? ;; FIXME: For kmacros, should we print the key-sequence?
(cond (cond
((symbolp function) ((symbolp function)