From 821b0ba8cb44c8804aa9f9e1f3591cd408840d9a Mon Sep 17 00:00:00 2001 From: jensbjorgensen Date: Fri, 21 Oct 2022 04:02:43 -0500 Subject: [PATCH] doc: add uv_poll_cb status==UV_EBADF note (#3797) --- docs/src/poll.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/src/poll.rst b/docs/src/poll.rst index 93a101ec..f5010892 100644 --- a/docs/src/poll.rst +++ b/docs/src/poll.rst @@ -101,7 +101,9 @@ API with one of the `UV_E*` error codes (see :ref:`errors`). The user should not close the socket while the handle is active. If the user does that anyway, the callback *may* be called reporting an error status, but this is - **not** guaranteed. + **not** guaranteed. If `status == UV_EBADF` polling is discontinued for the + file handle and no further events will be reported. The user should + then call :c:func:`uv_close` on the handle. .. note:: Calling :c:func:`uv_poll_start` on a handle that is already active is