procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; * lisp/help-at-pt.el (display-local-help): Doc fix.

Browse source
This commit is contained in:
Eli Zaretskii 2024-12-04 19:51:31 +02:00
parent 130c2a13dc
commit 02c53b9aab
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
lisp/help-at-pt.el
View file

@ -86,20 +86,20 @@ If this produces no string either, return nil."
;;;###autoload ;;;###autoload
(defun display-local-help (&optional inhibit-warning describe-button) (defun display-local-help (&optional inhibit-warning describe-button)
"Display local help in the echo area. "Display in the echo area `kbd-help' or `help-echo' text at point.
This command, by default, displays a short help message, namely This command displays the help message which is the string produced
the string produced by the `kbd-help' property at point. If by the `kbd-help' property at point. If `kbd-help' at point does not
`kbd-help' does not produce a string, but the `help-echo' produce a string, but the `help-echo' property does, then that string
property does, then that string is printed instead. is displayed instead.
The string is passed through `substitute-command-keys' before it The string is passed through `substitute-command-keys' before it
is displayed. is displayed.
If INHIBIT-WARNING is non-nil, this prevents display of a message If INHIBIT-WARNING is non-nil, this prevents display of the warning
in case there is no help. message in case there is no help properties at point.
If DESCRIBE-BUTTON in non-nil (interactively, the prefix arg), and If DESCRIBE-BUTTON in non-nil (interactively, the prefix arg), and
there's a button/widget at point, pop a buffer describing that there's a button/widget at point, pop up a buffer describing that
button/widget instead." button/widget instead."
(interactive (list nil current-prefix-arg)) (interactive (list nil current-prefix-arg))
(let ((help (help-at-pt-kbd-string))) (let ((help (help-at-pt-kbd-string)))