]> git.eshelyaron.com Git - emacs.git/commitdiff
Fix documentation of mouse-leave-buffer-hook
authorLars Ingebrigtsen <larsi@gnus.org>
Mon, 19 Jul 2021 14:41:54 +0000 (16:41 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Mon, 19 Jul 2021 14:41:54 +0000 (16:41 +0200)
* doc/lispref/hooks.texi (Standard Hooks): Ditto.

* src/callint.c (syms_of_callint): Document the actual usage of
`mouse-leave-buffer-hook' (bug#2932).

doc/lispref/hooks.texi
src/callint.c

index b1c7e6137198d203e15eef7a143b7eb8b20e2202..394928454b0d8de7592d4155366bd4d561678ede 100644 (file)
@@ -184,7 +184,7 @@ The command loop runs this soon after @code{post-command-hook} (q.v.).
 
 @item mouse-leave-buffer-hook
 @vindex mouse-leave-buffer-hook
-Hook run when about to switch windows with a mouse command.
+Hook run when the user mouse-clicks in a window.
 
 @item mouse-position-function
 @xref{Mouse Position}.
index 18624637843f2ba1c61dbf87545005d9247816d6..a196210250d9453f5dbd195012e0f2183ce301f6 100644 (file)
@@ -892,7 +892,10 @@ behave as if the mark were still active.  */);
   Vmark_even_if_inactive = Qt;
 
   DEFVAR_LISP ("mouse-leave-buffer-hook", Vmouse_leave_buffer_hook,
-              doc: /* Hook to run when about to switch windows with a mouse command.
+              doc: /* Hook run when the user mouse-clicks in a window.
+It can be run both before and after switching windows, or even when
+when not actually switching windows.
+
 Its purpose is to give temporary modes such as Isearch mode
 a way to turn themselves off when a mouse command switches windows.  */);
   Vmouse_leave_buffer_hook = Qnil;