From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sat, 8 Feb 2014 06:28:12 +0000 (-0800)
Subject: * simple.el (line-move): Document utility function used many
X-Git-Tag: emacs-24.3.90~173^2^2~42^2~45^2~101
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=6ef4f3cef2627334fa2f7fda02099b4b19452998;p=emacs.git

* simple.el (line-move): Document utility function used many
places in the Emacs sources.

Fixes: debbugs:14843
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 4b65d0b4ee2..99255517a57 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,8 @@
 2014-02-08  Lars Ingebrigtsen  <larsi@gnus.org>
 
+	* simple.el (line-move): Document utility function used many
+	places in the Emacs sources (bug#14843).
+
 	* dired.el (dired-mode-map): Make :help text more accurate (bug#14893).
 	(dired-prev-marked-file): Doc fix (bug#14855).
 	(dired-up-directory): Doc fix (bug#14848).
diff --git a/lisp/simple.el b/lisp/simple.el
index 124e04fd0c0..497e69f813d 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -5113,6 +5113,12 @@ The value is a floating-point number."
 ;; a cleaner solution to the problem of making C-n do something
 ;; useful given a tall image.
 (defun line-move (arg &optional noerror to-end try-vscroll)
+  "Move forward ARG lines.
+If NOERROR, don't signal an error if we can't move ARG lines.
+TO-END is unused.
+TRY-VSCROLL controls whether to vscroll tall lines: if either
+`auto-window-vscroll' or TRY-VSCROLL is nil, this function will
+not vscroll."
   (if noninteractive
       (forward-line arg)
     (unless (and auto-window-vscroll try-vscroll
@@ -5162,6 +5168,8 @@ The value is a floating-point number."
 ;; Arg says how many lines to move.  The value is t if we can move the
 ;; specified number of lines.
 (defun line-move-visual (arg &optional noerror)
+  "Move ARG lines forward.
+If NOERROR, don't signal an error if we can't move that many lines."
   (let ((opoint (point))
 	(hscroll (window-hscroll))
 	target-hscroll)