summaryrefslogtreecommitdiff
path: root/lisp/subr.el
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2014-02-09 22:56:03 -0800
committerLars Ingebrigtsen <larsi@gnus.org>2014-02-09 22:56:03 -0800
commit410155240f40333f38fbf170a844963b586cf09e (patch)
tree295bb67382b8008bc35712446c158b56736cea32 /lisp/subr.el
parent87c79dcb464250600234aa17f941d81f8028d9c3 (diff)
* subr.el (event-start): Say what a nil EVENT value means.
Diffstat (limited to 'lisp/subr.el')
-rw-r--r--lisp/subr.el3
1 files changed, 2 insertions, 1 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 1d2163267d..745d0b2f57 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -1019,7 +1019,8 @@ in the current Emacs session, then this function may return nil."
(defun event-start (event)
"Return the starting position of EVENT.
-EVENT should be a mouse click, drag, or key press event.
+EVENT should be a mouse click, drag, or key press event. If
+EVENT is nil, the value of `posn-at-point' is used instead.
The following accessor functions are used to access the elements
of the position: