(Miscellaneous String Operations): In string-filter
authorKevin Ryde <user42@zip.com.au>
Fri, 10 Jun 2005 22:38:57 +0000 (22:38 +0000)
committerKevin Ryde <user42@zip.com.au>
Fri, 10 Jun 2005 22:38:57 +0000 (22:38 +0000)
and string-delete, note result may share with input string (as allowed
by srfi spec).

doc/ref/api-data.texi

index 3e24d18..0895cc2 100755 (executable)
@@ -3605,20 +3605,22 @@ of @var{s}.
 
 @deffn {Scheme Procedure} string-filter s char_pred [start [end]]
 @deffnx {C Function} scm_string_filter (s, char_pred, start, end)
-Filter the string @var{s}, retaining only those characters that
-satisfy the @var{char_pred} argument.  If the argument is a
-procedure, it is applied to each character as a predicate, if
-it is a character, it is tested for equality and if it is a
-character set, it is tested for membership.
+Filter the string @var{s}, retaining only those characters which
+satisfy @var{char_pred}.  The result may share storage with @var{s}.
+
+If @var{char_pred} is a procedure, it is applied to each character as
+a predicate, if it is a character, it is tested for equality and if it
+is a character set, it is tested for membership.
 @end deffn
 
 @deffn {Scheme Procedure} string-delete s char_pred [start [end]]
 @deffnx {C Function} scm_string_delete (s, char_pred, start, end)
-Filter the string @var{s}, retaining only those characters that
-do not satisfy the @var{char_pred} argument.  If the argument
-is a procedure, it is applied to each character as a predicate,
-if it is a character, it is tested for equality and if it is a
-character set, it is tested for membership.
+Delete characters satisfying @var{char_pred} from @var{s}.  The result
+may share storage with @var{s}.
+
+If @var{char_pred} is a procedure, it is applied to each character as
+a predicate, if it is a character, it is tested for equality and if it
+is a character set, it is tested for membership.
 @end deffn
 
 @node Conversion to/from C