Skip to content

Commit 43a43ae

Browse files
committed
fixed docstring
1 parent c4e1551 commit 43a43ae

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

src/main/clojure/clojure/core/async.clj

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -488,15 +488,10 @@ to catch and handle."
488488
c)))
489489

490490
(defmacro io-thread
491-
"Asynchronously executes the body in a thread intended for I/O
492-
workloads, returning immediately to the calling thread.
493-
io-thread bodies may (either directly or indirectly) perform
494-
operations that may block indefinitely. Parking ops (i.e. <!,
495-
>! and alt!/alts!) used in io-thread bodies will throw at
496-
runtime.
497-
498-
Returns a channel which will receive the result of the body when
499-
completed"
491+
"Executes the body in a thread intended for blocking I/O workloads,
492+
returning immediately to the calling thread. The body must not do
493+
extended computation (if so, use 'thread' instead). Returns a channel
494+
which will receive the result of the body when completed, then close."
500495
[& body]
501496
`(thread-call (^:once fn* [] ~@body) @#'io-thread-exec))
502497

0 commit comments

Comments
 (0)