summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Heuer <kwzh@gnu.org>1996-07-13 01:03:02 +0000
committerKarl Heuer <kwzh@gnu.org>1996-07-13 01:03:02 +0000
commitdad89f36e94ef68a67d0057fe497b29e21807ce9 (patch)
tree34311491a1b1656a9fbaf73fcfce8989805e0a72
parent70e5376b90b0d91fdef2de54e0dc34d78437da0d (diff)
downloademacs-dad89f36e94ef68a67d0057fe497b29e21807ce9.tar.gz
(Fvertical_motion): Doc fix.
-rw-r--r--src/indent.c27
1 files changed, 16 insertions, 11 deletions
diff --git a/src/indent.c b/src/indent.c
index 2584b0478dc..503038b5401 100644
--- a/src/indent.c
+++ b/src/indent.c
@@ -1378,21 +1378,26 @@ vmotion (from, vtarget, w)
}
DEFUN ("vertical-motion", Fvertical_motion, Svertical_motion, 1, 2, 0,
- "Move to start of screen line LINES lines down.\n\
-If LINES is negative, this is moving up.\n\
+ "Move point to start of the screen line LINES lines down.\n\
+If LINES is negative, this means moving up.\n\
+\n\
+This function is an ordinary cursor motion function\n\
+which calculates the new position based on how text would be displayed.\n\
+The new position may be the start of a line,\n\
+or just the start of a continuation line.\n\
+The function returns number of screen lines moved over;\n\
+that usually equals LINES, but may be closer to zero\n\
+if beginning or end of buffer was reached.\n\
\n\
The optional second argument WINDOW specifies the window to use for\n\
parameters such as width, horizontal scrolling, and so on.\n\
-the default is the selected window.\n\
-It does not matter what buffer is displayed in WINDOW.\n\
-`vertical-motion' always uses the current buffer.\n\
-This makes it possible to use `vertical-motion' in any buffer,\n\
-whether or not it is currently displayed in some window.\n\
+The default is to use the selected window's parameters.\n\
\n\
-This function sets point to position found; this may be start of line\n\
-or just the start of a continuation line.\n\
-It returns number of lines moved; that may be closer to zero than LINES\n\
-if beginning or end of buffer was reached.")
+`vertical-motion' always uses the current buffer,\n\
+regardless of which buffer is displayed in WINDOW.\n\
+This is consistent with other cursor motion functions\n\
+and makes it possible to use `vertical-motion' in any buffer,\n\
+whether or not it is currently displayed in some window.")
(lines, window)
Lisp_Object lines, window;
{