diff options
| author | Eli Zaretskii | 2024-12-04 19:51:31 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2024-12-04 19:51:31 +0200 |
| commit | 02c53b9aab0f255e7fac39660febbbbfbc59ba25 (patch) | |
| tree | b3ce6c30c6dff1447ec10a83a6e3a206ea6b304a | |
| parent | 130c2a13dc72fca1677a986d3131398e908e58df (diff) | |
| download | emacs-02c53b9aab0f255e7fac39660febbbbfbc59ba25.tar.gz emacs-02c53b9aab0f255e7fac39660febbbbfbc59ba25.zip | |
; * lisp/help-at-pt.el (display-local-help): Doc fix.
| -rw-r--r-- | lisp/help-at-pt.el | 16 |
1 files changed, 8 insertions, 8 deletions
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." | |||
| 86 | 86 | ||
| 87 | ;;;###autoload | 87 | ;;;###autoload |
| 88 | (defun display-local-help (&optional inhibit-warning describe-button) | 88 | (defun display-local-help (&optional inhibit-warning describe-button) |
| 89 | "Display local help in the echo area. | 89 | "Display in the echo area `kbd-help' or `help-echo' text at point. |
| 90 | This command, by default, displays a short help message, namely | 90 | This command displays the help message which is the string produced |
| 91 | the string produced by the `kbd-help' property at point. If | 91 | by the `kbd-help' property at point. If `kbd-help' at point does not |
| 92 | `kbd-help' does not produce a string, but the `help-echo' | 92 | produce a string, but the `help-echo' property does, then that string |
| 93 | property does, then that string is printed instead. | 93 | is displayed instead. |
| 94 | 94 | ||
| 95 | The string is passed through `substitute-command-keys' before it | 95 | The string is passed through `substitute-command-keys' before it |
| 96 | is displayed. | 96 | is displayed. |
| 97 | 97 | ||
| 98 | If INHIBIT-WARNING is non-nil, this prevents display of a message | 98 | If INHIBIT-WARNING is non-nil, this prevents display of the warning |
| 99 | in case there is no help. | 99 | message in case there is no help properties at point. |
| 100 | 100 | ||
| 101 | If DESCRIBE-BUTTON in non-nil (interactively, the prefix arg), and | 101 | If DESCRIBE-BUTTON in non-nil (interactively, the prefix arg), and |
| 102 | there's a button/widget at point, pop a buffer describing that | 102 | there's a button/widget at point, pop up a buffer describing that |
| 103 | button/widget instead." | 103 | button/widget instead." |
| 104 | (interactive (list nil current-prefix-arg)) | 104 | (interactive (list nil current-prefix-arg)) |
| 105 | (let ((help (help-at-pt-kbd-string))) | 105 | (let ((help (help-at-pt-kbd-string))) |