[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master fff5c3c 1/2: help-at-pt-display-when-idle doc string clarificatio
From: |
Lars Ingebrigtsen |
Subject: |
master fff5c3c 1/2: help-at-pt-display-when-idle doc string clarification |
Date: |
Fri, 21 Aug 2020 10:56:05 -0400 (EDT) |
branch: master
commit fff5c3c061d99a067d728bd90ca00e329bb252ab
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>
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).
---
lisp/help-at-pt.el | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/lisp/help-at-pt.el b/lisp/help-at-pt.el
index dead1f6..e184c78 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