]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of 'inhibit-mouse-event-check'
authorEli Zaretskii <eliz@gnu.org>
Mon, 23 Aug 2021 19:14:03 +0000 (22:14 +0300)
committerEli Zaretskii <eliz@gnu.org>
Mon, 23 Aug 2021 19:14:03 +0000 (22:14 +0300)
* etc/NEWS:
* src/callint.c (syms_of_callint): Fix wording of the
documentation of 'inhibit-mouse-event-check'.

etc/NEWS
src/callint.c

index ed77443dbf03df30a568fa8ea4b73a390c367454..588290f433e5ec0394d03734e332bebc4e72699e 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -3848,9 +3848,9 @@ current buffer will be shown first in the "*xref*" buffer.
 
 ---
 ** New variable 'inhibit-mouse-event-check'.
-If bound to non-nil, a command with '(interactive "e")'
-doesn't signal an error when no mouse event is produced
-while using the keyboard.
+If bound to non-nil, a command with '(interactive "e")' doesn't signal
+an error when invoked by input event that is not a mouse click (e.g.,
+a key sequence).
 
 \f
 * Changes in Emacs 28.1 on Non-Free Operating Systems
index 5201dc7ba1617c3cc29aa9b14de0f574def6ffd1..44dae361c1f49cdea8add6c8fbcfd835e29af620 100644 (file)
@@ -901,10 +901,11 @@ a way to turn themselves off when a mouse command switches windows.  */);
   Vmouse_leave_buffer_hook = Qnil;
 
   DEFVAR_BOOL ("inhibit-mouse-event-check", inhibit_mouse_event_check,
-    doc: /* Non-nil means the interactive spec "e" doesn't check for events.
-In this case `(interactive "e")' doesn't signal an error when no mouse event
-is produced while using the keyboard.  Then `event-start', `event-end',
-`event-click-count' can create a new event.  */);
+    doc: /* Whether the interactive spec "e" requires a mouse gesture event.
+If non-nil, `(interactive "e")' doesn't signal an error when the command
+was invoked by an input event that is not a mouse gesture: a click, a drag,
+etc.  To create the event data when the input was some other event,
+use `event-start', `event-end', and `event-click-count'.  */);
   inhibit_mouse_event_check = false;
 
   defsubr (&Sinteractive);