]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify documentation of show-help-function slightly
authorLars Ingebrigtsen <larsi@gnus.org>
Wed, 9 Oct 2019 22:51:50 +0000 (00:51 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Wed, 9 Oct 2019 22:51:55 +0000 (00:51 +0200)
* doc/lispref/text.texi (Special Properties): Clarify where the
example in Tooltip mode is (bug#35392).

doc/lispref/text.texi

index ef1d8ebc571c947a639a896d33b168e8a98ac404..ef11ac26690860c7a1aa8a368c65293f27fb4cfa 100644 (file)
@@ -3733,15 +3733,16 @@ effectively disable them.
 @end defvar
 
 @defvar show-help-function
-@anchor{Help display} If this variable is non-@code{nil}, it specifies a
-function called to display help strings.  These may be @code{help-echo}
-properties, menu help strings (@pxref{Simple Menu Items},
-@pxref{Extended Menu Items}), or tool bar help strings (@pxref{Tool
-Bar}).  The specified function is called with one argument, the help
-string to display, which is passed through
+@anchor{Help display} If this variable is non-@code{nil}, it specifies
+a function called to display help strings.  These may be
+@code{help-echo} properties, menu help strings (@pxref{Simple Menu
+Items}, @pxref{Extended Menu Items}), or tool bar help strings
+(@pxref{Tool Bar}).  The specified function is called with one
+argument, the help string to display, which is passed through
 @code{substitute-command-keys} before being given to the function; see
-@ref{Keys in Documentation}.  Tooltip mode (@pxref{Tooltips,,, emacs,
-The GNU Emacs Manual}) provides an example.
+@ref{Keys in Documentation}.  See the code of Tooltip mode
+(@pxref{Tooltips,,, emacs, The GNU Emacs Manual}) for an example of a
+mode that uses @code{show-help-function}.
 @end defvar
 
 @defvar face-filters-always-match