summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Ryde <user42@zip.com.au>2005-01-23 21:16:46 +0000
committerKevin Ryde <user42@zip.com.au>2005-01-23 21:16:46 +0000
commitca04a5aef6c87bfabd82cfde182bf113813e175d (patch)
tree83d62b540bbb39688223b547ff7d99596e0ad5c0
parent2f0a4e30726e47261a759dd68cf39715269393b9 (diff)
downloadguile-ca04a5aef6c87bfabd82cfde182bf113813e175d.tar.gz
(SRFI-1 Searching): In member, note `=' called arg order.
-rw-r--r--doc/ref/srfi-modules.texi17
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/ref/srfi-modules.texi b/doc/ref/srfi-modules.texi
index edc5ccd31..d1c0d76ac 100644
--- a/doc/ref/srfi-modules.texi
+++ b/doc/ref/srfi-modules.texi
@@ -724,12 +724,19 @@ no set of elements pass then the return is @code{#f}.
@deffn {Scheme Procedure} member x lst [=]
Return the first sublist of @var{lst} whose @sc{car} is equal to
-@var{x}. If @var{x} does no appear in @var{lst}, return @code{#f}.
-Equality is determined by the equality predicate @var{=}, or
-@code{equal?} if @var{=} is not given.
+@var{x}. If @var{x} does not appear in @var{lst}, return @code{#f}.
-This function extends the core @code{member} by accepting an equality
-predicate. (@pxref{List Searching})
+Equality is determined by @code{equal?}, or by the equality predicate
+@var{=} if given. @var{=} is called @code{(= @var{x} elem)},
+ie.@: with the given @var{x} first, so for example to find the first
+element greater than 5,
+
+@example
+(member 5 '(3 5 1 7 2 9) <) @result{} (7 2 9)
+@end example
+
+This version of @code{member} extends the core @code{member}
+(@pxref{List Searching}) by accepting an equality predicate.
@end deffn