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 /libguile/srfi-13.c | |
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 'libguile/srfi-13.c')
-rw-r--r-- | libguile/srfi-13.c | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/libguile/srfi-13.c b/libguile/srfi-13.c index afeb80476..dfe948b92 100644 --- a/libguile/srfi-13.c +++ b/libguile/srfi-13.c @@ -1,6 +1,6 @@ /* srfi-13.c --- SRFI-13 procedures for Guile * - * Copyright (C) 2001, 2004, 2005, 2006, 2008, 2009, 2010 Free Software Foundation, Inc. + * Copyright (C) 2001, 2004, 2005, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public License @@ -1651,7 +1651,8 @@ SCM_DEFINE (scm_string_index, "string-index", 2, 2, 0, "\n" "@item\n" "is in the set @var{char_pred}, if it is a character set.\n" - "@end itemize") + "@end itemize\n\n" + "Return @code{#f} if no match is found.") #define FUNC_NAME s_scm_string_index { size_t cstart, cend; @@ -1715,7 +1716,8 @@ SCM_DEFINE (scm_string_index_right, "string-index-right", 2, 2, 0, "\n" "@item\n" "is in the set if @var{char_pred} is a character set.\n" - "@end itemize") + "@end itemize\n\n" + "Return @code{#f} if no match is found.") #define FUNC_NAME s_scm_string_index_right { size_t cstart, cend; @@ -1779,7 +1781,8 @@ SCM_DEFINE (scm_string_rindex, "string-rindex", 2, 2, 0, "\n" "@item\n" "is in the set if @var{char_pred} is a character set.\n" - "@end itemize") + "@end itemize\n\n" + "Return @code{#f} if no match is found.") #define FUNC_NAME s_scm_string_rindex { return scm_string_index_right (s, char_pred, start, end); |