Mercurial > emacs
diff src/editfns.c @ 71498:36c0b042a602
* editfns.c (Fdelete_field, Ffield_string, Ffield_beginning)
(Ffield_string_no_properties, Ffield_end): Mention
args-out-of-range error condition in docstring.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Wed, 28 Jun 2006 00:00:57 +0000 |
parents | f5917c21d187 |
children | fb57c1830788 138ce2701550 |
line wrap: on
line diff
--- a/src/editfns.c Tue Jun 27 17:49:31 2006 +0000 +++ b/src/editfns.c Wed Jun 28 00:00:57 2006 +0000 @@ -628,7 +628,10 @@ 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 @@ 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 @@ 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 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 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; {