summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2023-09-22 14:41:36 -0700
committerKaz Kylheku <kaz@kylheku.com>2023-09-22 14:41:36 -0700
commit5f4aa66d155e8324663c421b0f3b51ced11bb796 (patch)
treedd185679d6dfbf2af59021a92446e6c642f1b185
parent885c2aebbd4534c99f1f92f591800e1fcc6deab9 (diff)
downloadtxr-5f4aa66d155e8324663c421b0f3b51ced11bb796.tar.gz
txr-5f4aa66d155e8324663c421b0f3b51ced11bb796.tar.bz2
txr-5f4aa66d155e8324663c421b0f3b51ced11bb796.zip
doc: fix wording problem in hash-map.
* txr.1: Fix hash-map being described as constructing a function. It returns a hash table. Revise wording.
-rw-r--r--txr.114
1 files changed, 9 insertions, 5 deletions
diff --git a/txr.1 b/txr.1
index fdc993e7..42158a50 100644
--- a/txr.1
+++ b/txr.1
@@ -56322,20 +56322,24 @@ its properties, such as weakness.
.coNP Function @ hash-map
.synb
-.mets (hash-map < fun < sequence << hash-arg *)
+.mets (hash-map < function < sequence << hash-arg *)
.syne
.desc
The
.code hash-map
-function constructs a function out of a
-.metn sequence .
+function constructs a a hash table from a
+.meta sequence
+of keys and a
+.meta function
+which maps them to values.
+
The
-.meta fun
+.meta function
argument must be a function that can be called with one argument.
The elements of
.meta sequence
-become the hash keys. The value associated with each key
+become the keys of the returned hash table. The value associated with each key
is determined by passing that value to function
.meta fun
and taking the returned value.