From 613ceef28f493d4d77a93cf8b7be0ca8e9bbdda8 Mon Sep 17 00:00:00 2001 From: Simon Kissane Date: Tue, 25 May 2021 06:30:49 +1000 Subject: [PATCH] doc: uv_read_stop always succeeds Fixes: https://github.com/libuv/libuv/issues/3041 PR-URL: https://github.com/libuv/libuv/pull/3076 Reviewed-By: Jameson Nash --- docs/src/stream.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/src/stream.rst b/docs/src/stream.rst index 2ccb59b51..b5514c7df 100644 --- a/docs/src/stream.rst +++ b/docs/src/stream.rst @@ -145,6 +145,11 @@ API no longer be called. 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)