[Emacs-diffs] trunk r116335: * simple.el (line-move): Document utility function used many

[Lars Ingebrigtsen]

------------------------------------------------------------
revno: 116335
revision-id: address@hidden
parent: address@hidden
fixes bug: http://debbugs.gnu.org/14843
committer: Lars Ingebrigtsen <address@hidden>
branch nick: trunk
timestamp: Fri 2014-02-07 22:28:12 -0800
message:
  * simple.el (line-move): Document utility function used many
  places in the Emacs sources.
modified:
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/simple.el                 simple.el-20091113204419-o5vbwnq5f7feedwu-403

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-02-08 06:20:17 +0000
+++ b/lisp/ChangeLog    2014-02-08 06:28:12 +0000
@@ -1,5 +1,8 @@
 2014-02-08  Lars Ingebrigtsen  <address@hidden>
 
+       * 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).

=== modified file 'lisp/simple.el'
--- a/lisp/simple.el    2014-02-07 11:13:31 +0000
+++ b/lisp/simple.el    2014-02-08 06:28:12 +0000
@@ -5113,6 +5113,12 @@
 ;; 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 @@
 ;; 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)