changeset 56570:059dc717baef

(event-modifiers, event-basic-type): Doc fixes.
author Luc Teirlinck <teirllm@auburn.edu>
date Sat, 31 Jul 2004 15:45:30 +0000
parents a6cb62c42cec
children bf7d2966022c
files lisp/subr.el
diffstat 1 files changed, 9 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/subr.el	Sat Jul 31 15:43:26 2004 +0000
+++ b/lisp/subr.el	Sat Jul 31 15:45:30 2004 +0000
@@ -644,7 +644,11 @@
   "Return a list of symbols representing the modifier keys in event EVENT.
 The elements of the list may include `meta', `control',
 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
-and `down'."
+and `down'.
+EVENT may be an event or an event type.  If EVENT is a symbol
+that has never been used in an event that has been read as input
+in the current Emacs session, then this function can return nil,
+even when EVENT actually has modifiers."
   (let ((type event))
     (if (listp type)
 	(setq type (car type)))
@@ -671,7 +675,10 @@
 
 (defun event-basic-type (event)
   "Return the basic type of the given event (all modifiers removed).
-The value is a printing character (not upper case) or a symbol."
+The value is a printing character (not upper case) or a symbol.
+EVENT may be an event or an event type.  If EVENT is a symbol
+that has never been used in an event that has been read as input
+in the current Emacs session, then this function may return nil."
   (if (consp event)
       (setq event (car event)))
   (if (symbolp event)