aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLars Ingebrigtsen2019-10-10 00:51:50 +0200
committerLars Ingebrigtsen2019-10-10 00:51:55 +0200
commite4efab3f03cec69c87b2e3e28bd70f401821d96f (patch)
treea45ff719fa433aa47dc5bb2b199ff6f2a96de836
parent235b8b3a6d0b9ece617ab6408e72f1cf69bb919a (diff)
downloademacs-e4efab3f03cec69c87b2e3e28bd70f401821d96f.tar.gz
emacs-e4efab3f03cec69c87b2e3e28bd70f401821d96f.zip
Clarify documentation of show-help-function slightly
* doc/lispref/text.texi (Special Properties): Clarify where the example in Tooltip mode is (bug#35392).
-rw-r--r--doc/lispref/text.texi17
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index ef1d8ebc571..ef11ac26690 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -3733,15 +3733,16 @@ effectively disable them.
3733@end defvar 3733@end defvar
3734 3734
3735@defvar show-help-function 3735@defvar show-help-function
3736@anchor{Help display} If this variable is non-@code{nil}, it specifies a 3736@anchor{Help display} If this variable is non-@code{nil}, it specifies
3737function called to display help strings. These may be @code{help-echo} 3737a function called to display help strings. These may be
3738properties, menu help strings (@pxref{Simple Menu Items}, 3738@code{help-echo} properties, menu help strings (@pxref{Simple Menu
3739@pxref{Extended Menu Items}), or tool bar help strings (@pxref{Tool 3739Items}, @pxref{Extended Menu Items}), or tool bar help strings
3740Bar}). The specified function is called with one argument, the help 3740(@pxref{Tool Bar}). The specified function is called with one
3741string to display, which is passed through 3741argument, the help string to display, which is passed through
3742@code{substitute-command-keys} before being given to the function; see 3742@code{substitute-command-keys} before being given to the function; see
3743@ref{Keys in Documentation}. Tooltip mode (@pxref{Tooltips,,, emacs, 3743@ref{Keys in Documentation}. See the code of Tooltip mode
3744The GNU Emacs Manual}) provides an example. 3744(@pxref{Tooltips,,, emacs, The GNU Emacs Manual}) for an example of a
3745mode that uses @code{show-help-function}.
3745@end defvar 3746@end defvar
3746 3747
3747@defvar face-filters-always-match 3748@defvar face-filters-always-match