diff options
| author | Victor Stinner <victor.stinner@gmail.com> | 2014-05-28 22:14:03 (GMT) |
|---|---|---|
| committer | Victor Stinner <victor.stinner@gmail.com> | 2014-05-28 22:14:03 (GMT) |
| commit | a5b257af22976b9fdeb1907f8d0c50ef9b97facb (patch) | |
| tree | d22202ffa7107e37b0347832b149eb9e95e5de34 /Doc/library/asyncio-eventloop.rst | |
| parent | 28d0ae48e91bc08062b6c996b79fb148b8cf0303 (diff) | |
| download | cpython-a5b257af22976b9fdeb1907f8d0c50ef9b97facb.zip cpython-a5b257af22976b9fdeb1907f8d0c50ef9b97facb.tar.gz cpython-a5b257af22976b9fdeb1907f8d0c50ef9b97facb.tar.bz2 | |
Issue #21454: Fix asyncio.BaseEventLoop.connect_read_pipe doc
The function sets the the pipe to non-blocking mode.
Diffstat (limited to 'Doc/library/asyncio-eventloop.rst')
| -rw-r--r-- | Doc/library/asyncio-eventloop.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index 835266f..b961260 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -455,11 +455,11 @@ Connect pipes .. 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>`. |