changeset 40042:c9ad5da1f79d

(Fline_beginning_position, Fline_end_position): Clarify documentation.

--- a/src/editfns.c	Fri Oct 19 06:19:07 2001 +0000
+++ b/src/editfns.c	Fri Oct 19 06:22:46 2001 +0000
@@ -713,15 +713,16 @@
 }
 
 
-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 @@
 			      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 @@
   return Fconstrain_to_field (make_number (end_pos), make_number (orig),
 			      Qnil, Qt, Qnil);
 }
+
 
 Lisp_Object
 save_excursion_save ()