Commits

Victor Stinner  committed 8391f99 Merge

(Merge 3.4) Issue #21454: Fix asyncio.BaseEventLoop.connect_read_pipe doc

The function sets the the pipe to non-blocking mode.

  • Participants
  • Parent commits 03bb107, 16f3995

Comments (0)

Files changed (2)

File Doc/library/asyncio-eventloop.rst

 
 .. method:: BaseEventLoop.connect_read_pipe(protocol_factory, pipe)
 
-   Register read pipe in eventloop.
+   Register read pipe in eventloop. Set the *pipe* to non-blocking mode.
 
    *protocol_factory* should instantiate object with :class:`Protocol`
-   interface.  pipe is file-like object already switched to nonblocking.
-   Return pair (transport, protocol), where transport support
+   interface.  *pipe* is a :term:`file-like object <file object>`.
+   Return pair ``(transport, protocol)``, where *transport* supports the
    :class:`ReadTransport` interface.
 
    This method is a :ref:`coroutine <coroutine>`.

File Lib/asyncio/events.py

     # Pipes and subprocesses.
 
     def connect_read_pipe(self, protocol_factory, pipe):
-        """Register read pipe in event loop.
+        """Register read pipe in event loop. Set the pipe to non-blocking mode.
 
         protocol_factory should instantiate object with Protocol interface.
-        pipe is file-like object already switched to nonblocking.
-        Return pair (transport, protocol), where transport support
+        pipe is a file-like object.
+        Return pair (transport, protocol), where transport supports the
         ReadTransport interface."""
         # The reason to accept file-like object instead of just file descriptor
         # is: we need to own pipe and close it at transport finishing