]> git.eshelyaron.com Git - emacs.git/commitdiff
help-at-pt-display-when-idle doc string clarification
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 21 Aug 2020 14:33:33 +0000 (16:33 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Fri, 21 Aug 2020 14:33:33 +0000 (16:33 +0200)
* lisp/help-at-pt.el (help-at-pt-display-when-idle): Clarify when
kbd-help is useful (bug#39295).

lisp/help-at-pt.el

index dead1f6bf77bdd017a17a50b80896ecf620a6f50..e184c7826400969842e29bdfa2c7caed3161be59 100644 (file)
@@ -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