]> git.eshelyaron.com Git - emacs.git/commitdiff
; * lisp/help-at-pt.el (display-local-help): Doc fix.
authorEli Zaretskii <eliz@gnu.org>
Wed, 4 Dec 2024 17:51:31 +0000 (19:51 +0200)
committerEshel Yaron <me@eshelyaron.com>
Mon, 9 Dec 2024 12:46:22 +0000 (13:46 +0100)
(cherry picked from commit 02c53b9aab0f255e7fac39660febbbbfbc59ba25)

lisp/help-at-pt.el

index 95d0fafc54451bbbacaf956efcec1f681bc601f1..dcad09ef6ea4b5c49a14ab0d25b11d06ff6b9300 100644 (file)
@@ -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)))