From: Miles Bader <miles@gnu.org>
Date: Fri, 19 Oct 2001 06:22:46 +0000 (+0000)
Subject: (Fline_beginning_position, Fline_end_position): Clarify documentation.
X-Git-Tag: ttn-vms-21-2-B4~19360
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=6d57c3189e1a7b0ef6afee7b37a3c3b220af7671;p=emacs.git

(Fline_beginning_position, Fline_end_position): Clarify documentation.
---

diff --git a/src/editfns.c b/src/editfns.c
index 51d328ab2ec..661ad95d292 100644
--- a/src/editfns.c
+++ b/src/editfns.c
@@ -713,15 +713,16 @@ Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
 }
 
 
-DEFUN ("line-beginning-position", Fline_beginning_position, Sline_beginning_position,
-  0, 1, 0,
+DEFUN ("line-beginning-position",
+       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
        doc: /* Return the character position of the first character on the current line.
 With argument N not nil or 1, move forward N - 1 lines first.
 If scan reaches end of buffer, return that position.
-The scan does not cross a field boundary unless it would move
-beyond there to a different line.  Field boundaries are not noticed if
-`inhibit-field-text-motion' is non-nil.  And if N is nil or 1,
-and scan starts at a field boundary, the scan stops as soon as it starts.
+
+The scan does not cross a field boundary unless doing so would move
+beyond there to a different line; if N is nil or 1, and scan starts at a
+field boundary, the scan stops as soon as it starts.  To ignore field
+boundaries bind `inhibit-field-text-motion' to t.
 
 This function does not move point.  */)
      (n)
@@ -747,11 +748,16 @@ This function does not move point.  */)
 			      Qt, Qnil);
 }
 
-DEFUN ("line-end-position", Fline_end_position, Sline_end_position,
-  0, 1, 0,
+DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
        doc: /* Return the character position of the last character on the current line.
 With argument N not nil or 1, move forward N - 1 lines first.
 If scan reaches end of buffer, return that position.
+
+The scan does not cross a field boundary unless doing so would move
+beyond there to a different line; if N is nil or 1, and scan starts at a
+field boundary, the scan stops as soon as it starts.  To ignore field
+boundaries bind `inhibit-field-text-motion' to t.
+
 This function does not move point.  */)
      (n)
      Lisp_Object n;
@@ -770,6 +776,7 @@ This function does not move point.  */)
   return Fconstrain_to_field (make_number (end_pos), make_number (orig),
 			      Qnil, Qt, Qnil);
 }
+
 
 Lisp_Object
 save_excursion_save ()