[Emacs-diffs] emacs-24 r117480: Fix misleading doc string revealed in bug #18385.

[Eli Zaretskii]

------------------------------------------------------------
revno: 117480
revision-id: address@hidden
parent: address@hidden
fixes bug: http://debbugs.gnu.org/18385
committer: Eli Zaretskii <address@hidden>
branch nick: emacs-24
timestamp: Thu 2014-09-04 18:21:40 +0300
message:
  Fix misleading doc string revealed in bug #18385.
  
   lisp/subr.el (posn-actual-col-row): Doc fix.
modified:
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/subr.el                   subr.el-20091113204419-o5vbwnq5f7feedwu-151

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-09-02 19:51:25 +0000
+++ b/lisp/ChangeLog    2014-09-04 15:21:40 +0000
@@ -1,3 +1,7 @@
+2014-09-04  Eli Zaretskii  <address@hidden>
+
+       * subr.el (posn-actual-col-row): Doc fix.  (Bug#18385)
+
 2014-09-02  Stefan Monnier  <address@hidden>
 
        * emacs-lisp/package.el (package-generate-description-file):

=== modified file 'lisp/subr.el'
--- a/lisp/subr.el      2014-09-02 15:16:42 +0000
+++ b/lisp/subr.el      2014-09-04 15:21:40 +0000
@@ -1149,12 +1149,17 @@
              (/ (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)