summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2018-11-17 08:57:53 -0800
committerKaz Kylheku <kaz@kylheku.com>2018-11-17 08:57:53 -0800
commita5bef6eb5c7c27439ce292b1eab80acf195ca2fc (patch)
tree065e6d0a976ba7e81b92f01b6d1c434c94eacbdb
parentd656e64b6815678b87de402485cdec5222bce88b (diff)
downloadtxr-a5bef6eb5c7c27439ce292b1eab80acf195ca2fc.tar.gz
txr-a5bef6eb5c7c27439ce292b1eab80acf195ca2fc.tar.bz2
txr-a5bef6eb5c7c27439ce292b1eab80acf195ca2fc.zip
doc: use bulleted list under copy.
* txr.1: Present the type cases of the copy function using a more compact and visually appealing bulleted list.
-rw-r--r--txr.185
1 files changed, 29 insertions, 56 deletions
diff --git a/txr.1 b/txr.1
index 4bd7d2ff..933e32c1 100644
--- a/txr.1
+++ b/txr.1
@@ -26236,62 +26236,35 @@ is
it
returns
.codn nil .
-If
-.meta object
-is a list, it returns
-.cblk
-.meti (copy-list << object ).
-.cble
-If
-.meta object
-is a string, it returns
-.cblk
-.meti (copy-str << object ).
-.cble
-If
-.meta object
-is a vector, it returns
-.cblk
-.meti (copy-vec << object ).
-.cble
-If
-.meta object
-is a hash, it returns
-.cblk
-.meti (copy-hash << object ).
-.cble
-If
-.meta object
-is a structure, it returns
-.cblk
-.meti (copy-struct << object ).
-.cble
-If
-.meta object
-is a function, it returns
-.cblk
-.meti (copy-fun << object ).
-.cble
-If
-.meta object
-is a buffer, it returns
-.cblk
-.meti (copy-buf << object ).
-.cble
-If
-.meta object
-is a
-.codn carray ,
-it returns
-.cblk
-.meti (copy-carray << object ).
-.cble
-Lastly, if
-.meta object
-is a random state, it returns
-.cblk
-.meti (make-random-state << object ).
-.cble
+Otherwise,
+.code copy
+is equivalent to invoking a more specific copying function according to
+the type of the argument, as follows:
+.RS
+.coIP cons
+.meti (copy-list << object )
+.coIP str
+.meti (copy-str << object )
+.coIP vec
+.meti (copy-vec << object )
+.coIP hash
+.meti (copy-hash << object )
+.IP "struct type"
+.meti (copy-struct << object )
+.coIP fun
+.meti (copy-fun << object )
+.coIP buf
+.meti (copy-buf << object )
+.coIP carray
+.meti (copy-carray << object )
+.coIP random-state
+.meti (make-random-state << object )
+.RE
+
+.IP
+For all other types of
+.metn object ,
+the invocation is erroneous.
Except in the case when
.meta sequence