summaryrefslogtreecommitdiff
path: root/deps/uv/docs/src/pipe.rst
diff options
context:
space:
mode:
Diffstat (limited to 'deps/uv/docs/src/pipe.rst')
-rw-r--r--deps/uv/docs/src/pipe.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/deps/uv/docs/src/pipe.rst b/deps/uv/docs/src/pipe.rst
index 8f8402c29b..df896a0583 100644
--- a/deps/uv/docs/src/pipe.rst
+++ b/deps/uv/docs/src/pipe.rst
@@ -40,6 +40,10 @@ API
.. versionchanged:: 1.2.1 the file descriptor is set to non-blocking mode.
+ .. note::
+ The passed file descriptor or HANDLE is not checked for its type, but
+ it's required that it represents a valid pipe.
+
.. c:function:: int uv_pipe_bind(uv_pipe_t* handle, const char* name)
Bind the pipe to a file path (Unix) or a name (Windows).