Improve documentation of how vertical-motion interprets columns.

src/indent.c (Fvertical_motion): Doc fix.

 doc/lispref/positions.texi (Screen Lines): Clarify how columns are counted
 by vertical-motion.
This commit is contained in:
Eli Zaretskii 2014-06-21 11:17:29 +03:00
parent 637bce026b
commit 97a1ef484e
4 changed files with 20 additions and 4 deletions

View file

@ -1,3 +1,8 @@
2014-06-21 Eli Zaretskii <eliz@gnu.org>
* positions.texi (Screen Lines): Clarify how columns are counted
by vertical-motion.
2014-06-14 Eli Zaretskii <eliz@gnu.org>
* commands.texi (Accessing Mouse): Improve the wording of the

View file

@ -500,7 +500,11 @@ is negative, it moves up instead.
The @var{count} argument can be a cons cell, @code{(@var{cols}
. @var{lines})}, instead of an integer. Then the function moves by
@var{lines} screen lines, and puts point @var{cols} columns from the
start of that screen line.
visual start of that screen line. Note that @var{cols} are counted
from the @emph{visual} start of the line; if the window is scrolled
horizontally (@pxref{Horizontal Scrolling}), the column on which point
will end is in addition to the number of columns by which the text is
scrolled.
The return value is the number of screen lines over which point was
moved. The value may be less in absolute value than @var{count} if

View file

@ -1,3 +1,7 @@
2014-06-21 Eli Zaretskii <eliz@gnu.org>
* indent.c (Fvertical_motion): Doc fix.
2014-06-21 Paul Eggert <eggert@cs.ucla.edu>
Port to OS X ACLs (Bug#17810).

View file

@ -1944,9 +1944,12 @@ The optional second argument WINDOW specifies the window to use for
parameters such as width, horizontal scrolling, and so on.
The default is to use the selected window's parameters.
LINES can optionally take the form (COLS . LINES), in which case
the motion will not stop at the start of a screen line but on
its column COLS (if such exists on that line, that is).
LINES can optionally take the form (COLS . LINES), in which case the
motion will not stop at the start of a screen line but COLS column
from the visual start of the line (if such exists on that line, that
is). If the line is scrolled horizontally, COLS is interpreted
visually, i.e., as addition to the columns of text beyond the left
edge of the window.
`vertical-motion' always uses the current buffer,
regardless of which buffer is displayed in WINDOW.