From 9c7fce05050dd86673f656ef177413fc7855a12b Mon Sep 17 00:00:00 2001 From: Miles Bader Date: Sun, 25 Nov 2001 12:38:45 +0000 Subject: [PATCH] (Fields): Describe new `limit' arg in field-beginning/field-end. --- lispref/ChangeLog | 5 +++++ lispref/text.texi | 12 ++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/lispref/ChangeLog b/lispref/ChangeLog index d0ab7b221bc..606e30d23a5 100644 --- a/lispref/ChangeLog +++ b/lispref/ChangeLog @@ -1,3 +1,8 @@ +2001-11-25 Miles Bader + + * text.texi (Fields): Describe new `limit' arg in + field-beginning/field-end. + 2001-11-17 Eli Zaretskii * permute-index: Don't depend on csh-specific features. Replace diff --git a/lispref/text.texi b/lispref/text.texi index 1c417f29481..5f5b33f8177 100644 --- a/lispref/text.texi +++ b/lispref/text.texi @@ -3185,7 +3185,7 @@ to an empty field whose beginning and end are both at @var{pos}. 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 @@ If @var{pos} is at the beginning of its field, and 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 @@ If @var{pos} is at the end of its field, and @var{escape-from-edge} is 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 -- 2.39.2