aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/stream.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/src/stream.rst b/docs/src/stream.rst
index 429ebdab..58ef7d98 100644
--- a/docs/src/stream.rst
+++ b/docs/src/stream.rst
@@ -151,6 +151,11 @@ API
This function is idempotent and may be safely called on a stopped stream.
+ This function will always succeed; hence, checking its return value is
+ unnecessary. A non-zero return indicates that finishing releasing resources
+ may be pending on the next input event on that TTY on Windows, and does not
+ indicate failure.
+
.. c:function:: int uv_write(uv_write_t* req, uv_stream_t* handle, const uv_buf_t bufs[], unsigned int nbufs, uv_write_cb cb)
Write data to stream. Buffers are written in order. Example: