1berry/cpython
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

asyncio: Fix open_connection() documentation, writer is a StreamWriter

Browse Source
This commit is contained in:
Victor Stinner 2014-01-23 10:20:18 +01:00
parent d869a0b132
commit 3eb45d3eae
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/library/asyncio-protocol.rst
View File

@ -535,8 +535,8 @@ Network functions
A wrapper for :meth:`~BaseEventLoop.create_connection()` returning a (reader,
writer) pair.
The reader returned is a :class:`StreamReader` instance; the writer is a
transport.
The reader returned is a :class:`StreamReader` instance; the writer is
a :class:`StreamWriter` instance.
The arguments are all the usual arguments to
:meth:`BaseEventLoop.create_connection` except *protocol_factory*; most
@ -545,7 +545,7 @@ Network functions
Additional optional keyword arguments are *loop* (to set the event loop
instance to use) and *limit* (to set the buffer limit passed to the
StreamReader).
:class:`StreamReader`).
(If you want to customize the :class:`StreamReader` and/or
:class:`StreamReaderProtocol` classes, just copy the code -- there's really

2
Lib/asyncio/streams.py
View File

@ -21,7 +21,7 @@ def open_connection(host=None, port=None, *,
"""A wrapper for create_connection() returning a (reader, writer) pair.
The reader returned is a StreamReader instance; the writer is a
Transport.
StreamWriter.
The arguments are all the usual arguments to create_connection()
except protocol_factory; most common are positional host and port,