summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2021-08-02 18:29:22 -0700
committerKaz Kylheku <kaz@kylheku.com>2021-08-02 18:29:22 -0700
commit3f69d61563276436bef7c17296a1eb4fd8b15164 (patch)
treeb3fbd2ff311322762ab1f2f7a74bb3a49221eb86
parent8917924aa32cdd300895e02ebc3472f273dfa411 (diff)
downloadtxr-3f69d61563276436bef7c17296a1eb4fd8b15164.tar.gz
txr-3f69d61563276436bef7c17296a1eb4fd8b15164.tar.bz2
txr-3f69d61563276436bef7c17296a1eb4fd8b15164.zip
streams: document redundant close-stream.
* txr.1: Document that if close-stream is applied to a closed stream, then nil is returned without throwing an exception.
-rw-r--r--txr.110
1 files changed, 10 insertions, 0 deletions
diff --git a/txr.1 b/txr.1
index 6bde1bbc..12b64512 100644
--- a/txr.1
+++ b/txr.1
@@ -56707,6 +56707,16 @@ function throws an exception if an error occurs during the close operation
instead of returning
.codn nil .
+If
+.code close-stream
+is applied to a
+.meta stream
+which is already closed, the operation returns
+.code nil
+regardless of the
+.meta throw-on-error-p
+argument's value.
+
.coNP Macro @ with-stream
.synb
.mets (with-stream >> ( stream-var << init-form )