From df8ffa055d3e9487df52405f749a1c721426ae52 Mon Sep 17 00:00:00 2001 From: Chong Yidong Date: Wed, 28 Jun 2006 00:00:57 +0000 Subject: [PATCH] * editfns.c (Fdelete_field, Ffield_string, Ffield_beginning) (Ffield_string_no_properties, Ffield_end): Mention args-out-of-range error condition in docstring. --- src/ChangeLog | 6 ++++++ src/editfns.c | 25 ++++++++++++++++++++----- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/src/ChangeLog b/src/ChangeLog index db45905d4f2..06c9b970833 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,9 @@ +2006-06-27 Chong Yidong + + * editfns.c (Fdelete_field, Ffield_string, Ffield_beginning) + (Ffield_string_no_properties, Ffield_end): Mention + args-out-of-range error condition in docstring. + 2006-06-27 Kim F. Storm * xdisp.c (handle_composition_prop): Set stop_charpos before push_it. diff --git a/src/editfns.c b/src/editfns.c index 85ce94c8f8a..cbaf1bb18ac 100644 --- a/src/editfns.c +++ b/src/editfns.c @@ -628,7 +628,10 @@ find_field (pos, merge_at_boundary, beg_limit, beg, end_limit, end) DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0, doc: /* Delete the field surrounding POS. A field is a region of text with the same `field' property. -If POS is nil, the value of point is used for POS. */) +If POS is nil, the value of point is used for POS. + +An `args-out-of-range' error is signaled if POS is outside the +buffer's accessible portion. */) (pos) Lisp_Object pos; { @@ -642,7 +645,10 @@ If POS is nil, the value of point is used for POS. */) DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0, doc: /* Return the contents of the field surrounding POS as a string. A field is a region of text with the same `field' property. -If POS is nil, the value of point is used for POS. */) +If POS is nil, the value of point is used for POS. + +An `args-out-of-range' error is signaled if POS is outside the +buffer's accessible portion. */) (pos) Lisp_Object pos; { @@ -654,7 +660,10 @@ If POS is nil, the value of point is used for POS. */) DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0, doc: /* Return the contents of the field around POS, without text-properties. A field is a region of text with the same `field' property. -If POS is nil, the value of point is used for POS. */) +If POS is nil, the value of point is used for POS. + +An `args-out-of-range' error is signaled if POS is outside the +buffer's accessible portion. */) (pos) Lisp_Object pos; { @@ -670,7 +679,10 @@ If POS is nil, the value of point is used for POS. If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its field, then the beginning of the *previous* field is returned. If LIMIT is non-nil, it is a buffer position; if the beginning of the field -is before LIMIT, then LIMIT will be returned instead. */) +is before LIMIT, then LIMIT will be returned instead. + +An `args-out-of-range' error is signaled if POS is outside the +buffer's accessible portion. */) (pos, escape_from_edge, limit) Lisp_Object pos, escape_from_edge, limit; { @@ -686,7 +698,10 @@ If POS is nil, the value of point is used for POS. If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field, then the end of the *following* field is returned. If LIMIT is non-nil, it is a buffer position; if the end of the field -is after LIMIT, then LIMIT will be returned instead. */) +is after LIMIT, then LIMIT will be returned instead. + +An `args-out-of-range' error is signaled if POS is outside the +buffer's accessible portion. */) (pos, escape_from_edge, limit) Lisp_Object pos, escape_from_edge, limit; { -- 2.39.2