bug#18211: 24.4.50; doc string of `posnp'

[Lars Ingebrigtsen <larsi@gnus.org>]

Drew Adams <drew.adams@oracle.com> writes:

> Doc string:
>
>  Return non-nil if OBJ appears to be a valid `posn' object.
>
> What is a `posn' object?  What is a valid one?
>
> (elisp) `Accessing Mouse' gives an understandable description.  If it is
> correct then use something similar for the doc string:
>
>      returns non-`nil' if OBJECT is a mouse position list,
>                                     ^^^^^^^^^^^^^^^^^^^^^
>      in either of the formats documented in *note Click
>      Events::); and `nil' otherwise.
>
> (FWIW, that manual text should not say "either", since there are more
> than two such formats.  It should say "one".)

It currently says:

posnp is a compiled Lisp function in ‘subr.el’.

(posnp OBJ)

Return non-nil if OBJ appears to be a valid ‘posn’ object specifying a window.
If OBJ is a valid ‘posn’ object, but specifies a frame rather
than a window, return nil.

-----

I still don't know what it is, though.  :-)

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no