diff options
author | Ludovic Courtès <ludo@gnu.org> | 2011-01-04 18:08:58 +0100 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2011-01-04 18:08:58 +0100 |
commit | bf7c2e964e4b02670b3a8636dca080734183a534 (patch) | |
tree | f8b67eec32affbfc0c15fb49577e4cd9c2506f28 /doc/ref/api-data.texi | |
parent | 03f6e5ed4c897c3c8baa855ce3e00afef5e03785 (diff) | |
download | guile-bf7c2e964e4b02670b3a8636dca080734183a534.tar.gz |
Improve doc of `string-index', `string-index-right', and `string-rindex'.
Suggested by Noah Lavine <noah.b.lavine@gmail.com>.
* doc/ref/api-data.texi (String Searching): Mention the return value of
`string-index', `string-index-right', and `string-rindex' when no
match is found.
* libguile/srfi-13.c (scm_string_index, scm_string_index_right,
scm_string_rindex): Adjust docstring accordingly.
Diffstat (limited to 'doc/ref/api-data.texi')
-rwxr-xr-x | doc/ref/api-data.texi | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi index 14b81f5b5..2c990f9c2 100755 --- a/doc/ref/api-data.texi +++ b/doc/ref/api-data.texi @@ -1,6 +1,6 @@ @c -*-texinfo-*- @c This is part of the GNU Guile Reference Manual. -@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008, 2009, 2010 +@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2006, 2007, 2008, 2009, 2010, 2011 @c Free Software Foundation, Inc. @c See the file guile.texi for copying conditions. @@ -3398,6 +3398,8 @@ satisfies the predicate @var{char_pred}, if it is a procedure, @item is in the set @var{char_pred}, if it is a character set. @end itemize + +Return @code{#f} if no match is found. @end deffn @deffn {Scheme Procedure} string-rindex s char_pred [start [end]] @@ -3415,6 +3417,8 @@ satisfies the predicate @var{char_pred}, if it is a procedure, @item is in the set if @var{char_pred} is a character set. @end itemize + +Return @code{#f} if no match is found. @end deffn @deffn {Scheme Procedure} string-prefix-length s1 s2 [start1 [end1 [start2 [end2]]]] @@ -3476,6 +3480,8 @@ satisfies the predicate @var{char_pred}, if it is a procedure, @item is in the set if @var{char_pred} is a character set. @end itemize + +Return @code{#f} if no match is found. @end deffn @deffn {Scheme Procedure} string-skip s char_pred [start [end]] |