bug#20169: 25.0.50; doc of `posn-actual-col-row'

bug#20169: 25.0.50; doc of `posn-actual-col-row'

[Drew Adams]

Please add the information that is in the doc string to (elisp)
`Accessing Mouse'.  This means both the reference information about what
happens if POSITION does not contain the actual position and the guide
information about using `posn-col-row' in that case.

In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2014-10-20 on LEG570
Bzr revision: 118168 rgm@gnu.org-20141020195941-icp42t8ttcnud09g
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'

bug#20169: 25.0.50; doc of `posn-actual-col-row'

[Eli Zaretskii]

> Date: Sun, 22 Mar 2015 11:38:19 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> 
> Please add the information that is in the doc string to (elisp)
> `Accessing Mouse'.  This means both the reference information about what
> happens if POSITION does not contain the actual position and the guide
> information about using `posn-col-row' in that case.

The first part is already there, isn't it?

bug#20169: 25.0.50; doc of `posn-actual-col-row'

[Drew Adams]

> > Please add the information that is in the doc string to (elisp)
> > `Accessing Mouse'.  This means both the reference information about what
> > happens if POSITION does not contain the actual position and the guide
> > information about using `posn-col-row' in that case.
> 
> The first part is already there, isn't it?

Do you mean this?

  The function returns `nil' if POSITION does not include actual
  position values.

I meant that the manual should include the information that is in
the last two paragraphs of the doc string:

  Return nil if POSITION does not contain the actual position;
  in that case `posn-col-row' can be used to get approximate values.
  POSITION should be a list of the form returned by the `event-start'
  and `event-end' functions.

  This function does not account for the width on display, like the
  number of visual columns taken by a TAB or image.  If you need
  the coordinates of POSITION in character units, you should use
  `posn-col-row', not this function.

This is a lot more (and more useful) information than just what
is in its first line:

  Return nil if POSITION does not contain the actual position;

bug#20169: 25.0.50; doc of `posn-actual-col-row'

[Eli Zaretskii]

> Date: Sun, 22 Mar 2015 12:51:17 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 20169@debbugs.gnu.org
> 
> > > Please add the information that is in the doc string to (elisp)
> > > `Accessing Mouse'.  This means both the reference information about what
> > > happens if POSITION does not contain the actual position and the guide
> > > information about using `posn-col-row' in that case.
> > 
> > The first part is already there, isn't it?
> 
> Do you mean this?
> 
>   The function returns `nil' if POSITION does not include actual
>   position values.
> 
> I meant that the manual should include the information that is in
> the last two paragraphs of the doc string:
> 
>   Return nil if POSITION does not contain the actual position;
>   in that case `posn-col-row' can be used to get approximate values.
>   POSITION should be a list of the form returned by the `event-start'
>   and `event-end' functions.
> 
>   This function does not account for the width on display, like the
>   number of visual columns taken by a TAB or image.  If you need
>   the coordinates of POSITION in character units, you should use
>   `posn-col-row', not this function.
> 
> This is a lot more (and more useful) information than just what
> is in its first line:
> 
>   Return nil if POSITION does not contain the actual position;

Right, fixed.