Skip to content

Commit 82b4b3b

Browse files
authored
Merge pull request #221 from figurantpp/fix-blocking-close
Fix close! misleading doc
2 parents 900f9d4 + 69e3cb9 commit 82b4b3b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/manifold/stream.clj

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,10 @@
196196
`(.isSynchronous ~(with-meta x {:tag "manifold.stream.core.IEventStream"})))
197197

198198
(definline close!
199-
"Closes a source or sink, so that it can't emit or accept any more messages."
199+
"Closes a sink, so you can't `put!` any more messages onto it.
200+
201+
Note that if it's also a source, `take!`s will still work until the source is drained."
202+
200203
[sink]
201204
`(.close ~(with-meta sink {:tag "manifold.stream.core.IEventStream"})))
202205

0 commit comments

Comments
 (0)