[Patch] Documentation Fix

[Patch] Documentation Fix

[Noah Lavine]

[-- Attachment #1: Type: text/plain, Size: 202 bytes --]

Hello all,

I was looking in the documentation at the string-index and
string-rindex functions, and I realized that it didn't say what they
did if they didn't find a match. This patch fixes that.

Noah

[-- Attachment #2: 0001-Document-string-index.patch --]
[-- Type: application/octet-stream, Size: 1163 bytes --]

From 19bb0db0194de31a787627c67ba73d6258ea710e Mon Sep 17 00:00:00 2001
From: Noah Lavine <nlavine@haverford.edu>
Date: Mon, 3 Jan 2011 17:58:36 -0500
Subject: [PATCH] Document string-index

Add a note to the documentation that if the string-index and string-rindex
procedures do not find a match for their predicate, they will return #f.
---
 doc/ref/api-data.texi |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi
index 14b81f5..13b566f 100755
--- a/doc/ref/api-data.texi
+++ b/doc/ref/api-data.texi
@@ -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
+
+Returns #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
+
+Returns #f if no match is found.
 @end deffn
 
 @deffn {Scheme Procedure} string-prefix-length s1 s2 [start1 [end1 [start2 [end2]]]]
-- 
1.7.3.2

Re: [Patch] Documentation Fix

[Ludovic Courtès]

Hi!

Noah Lavine <noah.b.lavine@gmail.com> writes:

> I was looking in the documentation at the string-index and
> string-rindex functions, and I realized that it didn't say what they
> did if they didn't find a match. This patch fixes that.

Thanks, applied with small changes.

Ludo’.