Fix misleading doc string revealed in bug #18385.

lisp/subr.el (posn-actual-col-row): Doc fix.
This commit is contained in:
Eli Zaretskii
2014-09-04 18:21:40 +03:00
parent e97a29cbec
commit 304661b97f
2 changed files with 13 additions and 4 deletions

View File

@@ -1,3 +1,7 @@
2014-09-04 Eli Zaretskii <eliz@gnu.org>
* subr.el (posn-actual-col-row): Doc fix. (Bug#18385)
2014-09-02 Stefan Monnier <monnier@iro.umontreal.ca>
* emacs-lisp/package.el (package-generate-description-file):

View File

@@ -1149,12 +1149,17 @@ and `event-end' functions."
(/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
(defun posn-actual-col-row (position)
"Return the actual column and row in POSITION, measured in characters.
These are the actual row number in the window and character number in that row.
"Return the window row number in POSITION and character number in that row.
Return nil if POSITION does not contain the actual position; in that case
`posn-col-row' can be used to get approximate values.
\`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."
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."
(nth 6 position))
(defsubst posn-timestamp (position)