changeset 102848:dc76a141c3e6

* positions.texi (Screen Lines): Document (cols . lines) argument for vertical-motion.
author Chong Yidong <cyd@stupidchicken.com>
date Sun, 05 Apr 2009 05:11:48 +0000
parents 1d6560028c66
children ec97c15e7e13
files doc/lispref/ChangeLog doc/lispref/positions.texi
diffstat 2 files changed, 13 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/doc/lispref/ChangeLog	Sun Apr 05 03:25:57 2009 +0000
+++ b/doc/lispref/ChangeLog	Sun Apr 05 05:11:48 2009 +0000
@@ -1,3 +1,8 @@
+2009-04-05  Chong Yidong  <cyd@stupidchicken.com>
+
+	* positions.texi (Screen Lines): Document (cols . lines) argument
+	for vertical-motion.
+
 2009-04-04  Chong Yidong  <cyd@stupidchicken.com>
 
 	* frames.texi (Frames): Clean up introduction.  Document `ns'
--- a/doc/lispref/positions.texi	Sun Apr 05 03:25:57 2009 +0000
+++ b/doc/lispref/positions.texi	Sun Apr 05 05:11:48 2009 +0000
@@ -520,9 +520,14 @@
 screen lines down from the screen line containing point.  If @var{count}
 is negative, it moves up instead.
 
-@code{vertical-motion} returns the number of screen lines over which it
-moved point.  The value may be less in absolute value than @var{count}
-if the beginning or end of the buffer was reached.
+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.
+
+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
+the beginning or end of the buffer was reached.
 
 The window @var{window} is used for obtaining parameters such as the
 width, the horizontal scrolling, and the display table.  But