summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2017-06-11 08:13:21 -0700
committerKaz Kylheku <kaz@kylheku.com>2017-06-11 08:13:21 -0700
commite73d2c1da4c80f33b8184b8646199eb47dbb7edf (patch)
tree644071e827e91a7642fcc382c9dd3bf6fb199864
parenteba67f889053e26a8bd2776c7d290d54a621287c (diff)
downloadtxr-e73d2c1da4c80f33b8184b8646199eb47dbb7edf.tar.gz
txr-e73d2c1da4c80f33b8184b8646199eb47dbb7edf.tar.bz2
txr-e73d2c1da4c80f33b8184b8646199eb47dbb7edf.zip
doc: document length for buf.
* txr.1: Restructure the length documentation to use definition-style paragraphs, and add buf.
-rw-r--r--txr.123
1 files changed, 13 insertions, 10 deletions
diff --git a/txr.1 b/txr.1
index 18137aa2..bd5de7e3 100644
--- a/txr.1
+++ b/txr.1
@@ -24775,17 +24775,14 @@ is a sequence, the
function returns the number of items it
contains.
-If
-.meta object
-is a hash then the value of
-.cblk
-.meti (hash-count << object )
-.cble
+The function supports these additional types:
+.RS
+.coIP hash
+The value of
+.code hash-count
is returned.
-
-If
-.meta object
-is a range, then the length of the interval
+.coIP range
+The length of the interval
represented by the range is returned.
The length of a range
.code r
@@ -24797,7 +24794,13 @@ The length of
is -11 and of
.codn "#R(0.5 3)" ,
2.5.
+.coIP buf
+The buffer length calculated by
+.code length-buf
+is returned.
+.RE
+.IP
For other types,
.code length
throws an error exception.