From: Eli Zaretskii Date: Wed, 4 Dec 2024 17:51:31 +0000 (+0200) Subject: ; * lisp/help-at-pt.el (display-local-help): Doc fix. X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f2244dc38465ea0aa8ba896b1af677e46c5ec6e7;p=emacs.git ; * lisp/help-at-pt.el (display-local-help): Doc fix. (cherry picked from commit 02c53b9aab0f255e7fac39660febbbbfbc59ba25) --- diff --git a/lisp/help-at-pt.el b/lisp/help-at-pt.el index 95d0fafc544..dcad09ef6ea 100644 --- a/lisp/help-at-pt.el +++ b/lisp/help-at-pt.el @@ -86,20 +86,20 @@ If this produces no string either, return nil." ;;;###autoload (defun display-local-help (&optional inhibit-warning describe-button) - "Display local help in the echo area. -This command, by default, displays a short help message, namely -the string produced by the `kbd-help' property at point. If -`kbd-help' does not produce a string, but the `help-echo' -property does, then that string is printed instead. + "Display in the echo area `kbd-help' or `help-echo' text at point. +This command displays the help message which is the string produced +by the `kbd-help' property at point. If `kbd-help' at point does not +produce a string, but the `help-echo' property does, then that string +is displayed instead. The string is passed through `substitute-command-keys' before it is displayed. -If INHIBIT-WARNING is non-nil, this prevents display of a message -in case there is no help. +If INHIBIT-WARNING is non-nil, this prevents display of the warning +message in case there is no help properties at point. 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." (interactive (list nil current-prefix-arg)) (let ((help (help-at-pt-kbd-string)))