changeset 41490:794e4afabce0

(Fields): Describe new `limit' arg in field-beginning/field-end.
author Miles Bader <miles@gnu.org>
date Sun, 25 Nov 2001 12:38:29 +0000
parents 400c9b70d5f1
children 369ebb0fe30b
files lispref/text.texi
diffstat 1 files changed, 10 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/text.texi	Sun Nov 25 11:36:17 2001 +0000
+++ b/lispref/text.texi	Sun Nov 25 12:38:29 2001 +0000
@@ -3185,7 +3185,7 @@
   In all of these functions, if @var{pos} is omitted or @code{nil}, the
 value of point is used by default.
 
-@defun field-beginning &optional pos escape-from-edge
+@defun field-beginning &optional pos escape-from-edge limit
 @tindex field-beginning
 This function returns the beginning of the field specified by @var{pos}.
 
@@ -3194,9 +3194,13 @@
 always the beginning of the preceding field that @emph{ends} at @var{pos},
 regardless of the stickiness of the @code{field} properties around
 @var{pos}.
+
+If @var{limit} is non-@code{nil}, it is a buffer position; if the
+beginning of the field is before @var{limit}, then @var{limit} will be
+returned instead.
 @end defun
 
-@defun field-end &optional pos escape-from-edge
+@defun field-end &optional pos escape-from-edge limit
 @tindex field-end
 This function returns the end of the field specified by @var{pos}.
 
@@ -3204,6 +3208,10 @@
 non-@code{nil}, then the return value is always the end of the following
 field that @emph{begins} at @var{pos}, regardless of the stickiness of
 the @code{field} properties around @var{pos}.
+
+If @var{limit} is non-@code{nil}, it is a buffer position; if the end
+of the field is after @var{limit}, then @var{limit} will be returned
+instead.
 @end defun
 
 @defun field-string &optional pos