Skip to content

Commit 73defb8

Browse files
committed
DFRS-4 - update docstring for create-reader and create-writer
1 parent 909df49 commit 73defb8

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/main/clojure/clojure/data/fressian.clj

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -192,16 +192,17 @@
192192

193193
(defn ^Writer create-writer
194194
"Create a fressian writer targeting out. Handlers must be
195-
a nested map of type => tag => WriteHandler, see
195+
a nested map of type => tag => WriteHandler wrapped with
196+
associative-lookup and inheritance-lookup. See
196197
clojure-write-handlers for an example."
197198
[^OutputStream out & {:keys [handlers]}]
198199
(FressianWriter. out (or handlers (-> clojure-write-handlers associative-lookup inheritance-lookup))))
199200

200201
(defn ^Reader create-reader
201202
"Create a fressian reader targeting in, which must be compatible
202-
with clojure.java.io/input-stream. Handlers can be an ILookup
203-
or a map of tag => ReadHandler, see clojure-read-handlers for
204-
an example."
203+
with clojure.java.io/input-stream. Handlers must be a map of
204+
tag => ReadHandler wrapped in associative-lookup. See
205+
clojure-read-handlers for an example."
205206
[^InputStream in & {:keys [handlers checksum?]}]
206207
(FressianReader. in
207208
(or handlers (associative-lookup clojure-read-handlers))

0 commit comments

Comments
 (0)