summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2016-05-03 00:08:31 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2016-05-03 00:08:31 +0200
commit8544b9879c652e7c700652a4ba6fd17245163bd4 (patch)
tree8819fc1c3b91e2f59cd1f2b449d4819d96889256
parent805204f3efdf3e9cb3ccd2783b7ba44f8c1fdb5a (diff)
downloademacs-8544b9879c652e7c700652a4ba6fd17245163bd4.tar.gz
posnp doc clarification
* lisp/subr.el (posnp): Mention that a posn object is returned from `event-start' (bug#18211).
-rw-r--r--lisp/subr.el1
1 files changed, 1 insertions, 0 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 3f5d6e427e9..0f021701e9f 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -1117,6 +1117,7 @@ The return value is a positive integer."
(defun posnp (obj)
"Return non-nil if OBJ appears to be a valid `posn' object specifying a window.
+A `posn' object is returned from functions such as `event-start'.
If OBJ is a valid `posn' object, but specifies a frame rather
than a window, return nil."
;; FIXME: Correct the behavior of this function so that all valid