]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify event-convert-list doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Sun, 18 Jul 2021 16:18:03 +0000 (18:18 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 18 Jul 2021 16:18:03 +0000 (18:18 +0200)
* src/keyboard.c (Fevent_convert_list): Clarify that the base type
returned isn't always the same (bug#7631).

src/keyboard.c

index 6174a4aad9264a33b34ac1d5ed7e70af1c703643..77d6bbba623e3442746173d82e977d1e4dbf1713 100644 (file)
@@ -6622,8 +6622,11 @@ DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
 EVENT-DESC should contain one base event type (a character or symbol)
 and zero or more modifier names (control, meta, hyper, super, shift, alt,
 drag, down, double or triple).  The base must be last.
-The return value is an event type (a character or symbol) which
-has the same base event type and all the specified modifiers.  */)
+
+The return value is an event type (a character or symbol) which has
+essentially the same base event type and all the specified modifiers.
+(Some compatibility base types, like symbols that represent a
+character, are not returned verbatim.)  */)
   (Lisp_Object event_desc)
 {
   Lisp_Object base = Qnil;