From e4efab3f03cec69c87b2e3e28bd70f401821d96f Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Thu, 10 Oct 2019 00:51:50 +0200 Subject: [PATCH] Clarify documentation of show-help-function slightly * doc/lispref/text.texi (Special Properties): Clarify where the example in Tooltip mode is (bug#35392). --- doc/lispref/text.texi | 17 +++++++++-------- 1 file 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. @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 -- 2.39.5