diff options
author | Lars Ingebrigtsen <larsi@gnus.org> | 2020-08-21 16:33:33 +0200 |
---|---|---|
committer | Lars Ingebrigtsen <larsi@gnus.org> | 2020-08-21 16:33:33 +0200 |
commit | fff5c3c061d99a067d728bd90ca00e329bb252ab (patch) | |
tree | 3e9e65339852785a1e9aeab60b62aaba03b3e177 /lisp/help-at-pt.el | |
parent | 70964b9c6b8458a7529ab0eb5563321c65a43f4f (diff) | |
download | emacs-fff5c3c061d99a067d728bd90ca00e329bb252ab.tar.gz |
help-at-pt-display-when-idle doc string clarification
* lisp/help-at-pt.el (help-at-pt-display-when-idle): Clarify when
kbd-help is useful (bug#39295).
Diffstat (limited to 'lisp/help-at-pt.el')
-rw-r--r-- | lisp/help-at-pt.el | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/lisp/help-at-pt.el b/lisp/help-at-pt.el index dead1f6bf77..e184c782640 100644 --- a/lisp/help-at-pt.el +++ b/lisp/help-at-pt.el @@ -162,6 +162,10 @@ included in this list. Suggested properties are `keymap', `local-map', `button' and `kbd-help'. Any value other than t or a non-empty list disables the feature. +The text printed from the `help-echo' property is often only +relevant when using the mouse. The presence of a `kbd-help' +property guarantees that non mouse specific help is available. + This variable only takes effect after a call to `help-at-pt-set-timer'. The help gets printed after Emacs has been idle for `help-at-pt-timer-delay' seconds. You can call |