Fix misleading doc string revealed in bug #18385.

 lisp/subr.el (posn-actual-col-row): Doc fix.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 1e130d05cf61648002efc620f872b50b7ccb37d5..c716ac8dc0a8b7f68b1530200467a492b6fd3592 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -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):

diff --git a/lisp/subr.el b/lisp/subr.el
index 089e3efe79c80a3647738e80910cf635838a8b4c..12704da149bcb6d44ed6a77358e114b30c860aa0 100644 (file)
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -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)