[Emacs-diffs] emacs-24 r117242: Fix documentation mentioned in bug #17768.

[Eli Zaretskii]

------------------------------------------------------------
revno: 117242
revision-id: address@hidden
parent: address@hidden
fixes bug: http://debbugs.gnu.org/17768
committer: Eli Zaretskii <address@hidden>
branch nick: emacs-24
timestamp: Sat 2014-06-14 19:37:15 +0300
message:
  Fix documentation mentioned in bug #17768.
  
   lisp/subr.el (posn-col-row): Doc fix.
  
   doc/lispref/commands.texi (Accessing Mouse): Improve the wording of the
   posn-col-row documentation.
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/commands.texi      
commands.texi-20091113204419-o5vbwnq5f7feedwu-6165
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/subr.el                   subr.el-20091113204419-o5vbwnq5f7feedwu-151

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-06-08 17:46:51 +0000
+++ b/doc/lispref/ChangeLog     2014-06-14 16:37:15 +0000
@@ -1,3 +1,8 @@
+2014-06-14  Eli Zaretskii  <address@hidden>
+
+       * commands.texi (Accessing Mouse): Improve the wording of the
+       posn-col-row documentation.  (Bug#17768)
+
 2014-06-08  Glenn Morris  <address@hidden>
 
        * os.texi (Startup Summary): Small fix for initial-buffer-choice.

=== modified file 'doc/lispref/commands.texi'
--- a/doc/lispref/commands.texi 2014-03-22 21:41:31 +0000
+++ b/doc/lispref/commands.texi 2014-06-14 16:37:15 +0000
@@ -2049,23 +2049,24 @@
 @defun posn-col-row position
 This function returns a cons cell @code{(@var{col} .  @var{row})},
 containing the estimated column and row corresponding to buffer
-position @var{position}.  The return value is given in units of the
-frame's default character width and height, as computed from the
address@hidden and @var{y} values corresponding to @var{position}.  (So, if
-the actual characters have non-default sizes, the actual row and
-column may differ from these computed values.)
+position in @var{position}.  The return value is given in units of the
+frame's default character width and default line height (including
+spacing), as computed from the @var{x} and @var{y} values
+corresponding to @var{position}.  (So, if the actual characters have
+non-default sizes, the actual row and column may differ from these
+computed values.)
 
 Note that @var{row} is counted from the top of the text area.  If the
-window possesses a header line (@pxref{Header Lines}), it is
address@hidden counted as the first line.
+window given by @var{position} possesses a header line (@pxref{Header
+Lines}), it is @emph{not} included in the @var{row} count.
 @end defun
 
 @defun posn-actual-col-row position
 Return the actual row and column in @var{position}, as a cons cell
 @code{(@var{col} . @var{row})}.  The values are the actual row and
-column numbers in the window.  @xref{Click Events}, for details.  It
-returns @code{nil} if @var{position} does not include actual positions
-values.
+column numbers in the window given by @var{position}.  @xref{Click
+Events}, for details.  The function returns @code{nil} if
address@hidden does not include actual position values.
 @end defun
 
 @defun posn-string position

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-06-14 09:50:13 +0000
+++ b/lisp/ChangeLog    2014-06-14 16:37:15 +0000
@@ -1,3 +1,7 @@
+2014-06-14  Eli Zaretskii  <address@hidden>
+
+       * subr.el (posn-col-row): Doc fix.  (Bug#17768)
+
 2014-06-14  Juri Linkov  <address@hidden>
 
        * bindings.el: Put `ascii-character' property on keypad keys

=== modified file 'lisp/subr.el'
--- a/lisp/subr.el      2014-05-31 20:02:47 +0000
+++ b/lisp/subr.el      2014-06-14 16:37:15 +0000
@@ -1117,7 +1117,7 @@
   "Return the nominal column and row in POSITION, measured in characters.
 The column and row values are approximations calculated from the x
 and y coordinates in POSITION and the frame's default character width
-and height.
+and default line height, including spacing.
 For a scroll-bar event, the result column is 0, and the row
 corresponds to the vertical position of the click in the scroll bar.
 POSITION should be a list of the form returned by the `event-start'