summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2022-07-18 06:46:44 -0700
committerKaz Kylheku <kaz@kylheku.com>2022-07-18 06:46:44 -0700
commit14cb5835e5ecb14be8ecc6ac2a6811e4bb143354 (patch)
treefda64a7089b5028fd4f3c67fafbb98a333016e02
parent1fcd2951cbca8b1a72b0a7665032859139f03d10 (diff)
downloadtxr-14cb5835e5ecb14be8ecc6ac2a6811e4bb143354.tar.gz
txr-14cb5835e5ecb14be8ecc6ac2a6811e4bb143354.tar.bz2
txr-14cb5835e5ecb14be8ecc6ac2a6811e4bb143354.zip
doc: pos function.
* txr.1: Improve unclear wording describing pos function.
-rw-r--r--txr.114
1 files changed, 9 insertions, 5 deletions
diff --git a/txr.1 b/txr.1
index cfd0c31f..09312ed2 100644
--- a/txr.1
+++ b/txr.1
@@ -34559,15 +34559,19 @@ to
If this argument is omitted, then the
.code equal
function is used.
-The position of the first element
+The
+.code pos
+function returns the position of the first element of
.meta sequence
whose comparison key (as
retrieved by
.metn keyfun )
-matches the search (under
-.metn testfun )
-is
-returned. If no such element is found,
+matches
+.metn key ,
+as compared by the
+.meta testfun
+function.
+If no such element is found,
.code nil
is returned.