diff options
author | Eli Zaretskii <eliz@gnu.org> | 2014-06-14 19:37:15 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2014-06-14 19:37:15 +0300 |
commit | 859488bf227da300a4d1f90a51222b163165dfae (patch) | |
tree | 4f88a3fd3b295bd82146ba7291923fcf995cfd40 /doc | |
parent | 59579a97d870807c635292178a2697f20d8720bd (diff) | |
download | emacs-859488bf227da300a4d1f90a51222b163165dfae.tar.gz |
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.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
-rw-r--r-- | doc/lispref/commands.texi | 21 |
2 files changed, 16 insertions, 10 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 2b00d9743b7..c20a20409a2 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,8 @@ +2014-06-14 Eli Zaretskii <eliz@gnu.org> + + * commands.texi (Accessing Mouse): Improve the wording of the + posn-col-row documentation. (Bug#17768) + 2014-06-08 Glenn Morris <rgm@gnu.org> * os.texi (Startup Summary): Small fix for initial-buffer-choice. diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 38a6970e6f4..c478b7847d2 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi @@ -2049,23 +2049,24 @@ POSITION is assumed to lie in a window text area." @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 -@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.) +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 -@emph{not} 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 +@var{position} does not include actual position values. @end defun @defun posn-string position |