Skip to content

Commit

Permalink
Clarify docstring of write-body-to-stream
Browse files Browse the repository at this point in the history
Closes #491.
  • Loading branch information
weavejester committed Jun 19, 2024
1 parent 8e84ca5 commit f92911c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion ring-core-protocols/src/ring/core/protocols.clj
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
(write-body-to-stream [body response output-stream]
"Write a value representing a response body to an output stream. The stream
will be closed after the value had been written. The stream may be written
asynchronously."))
asynchronously from asynchronous handlers. In synchronous handlers, the
response is considered completed once this method ends."))

;; The following private functions are replicated from ring.util.response in
;; order to allow third-party adapters to use StreamableResponseBody without the
Expand Down

0 comments on commit f92911c

Please sign in to comment.