[Python-checkins] cpython: asyncio: Fix open_connection() documentation, writer is a StreamWriter

victor.stinner python-checkins at python.org
Thu Jan 23 10:21:02 CET 2014


http://hg.python.org/cpython/rev/dcfbce47c024
changeset:   88648:dcfbce47c024
parent:      88646:89b738e3d0c9
user:        Victor Stinner <victor.stinner at gmail.com>
date:        Thu Jan 23 10:20:18 2014 +0100
summary:
  asyncio: Fix open_connection() documentation, writer is a StreamWriter

files:
  Doc/library/asyncio-protocol.rst |  6 +++---
  Lib/asyncio/streams.py           |  2 +-
  2 files changed, 4 insertions(+), 4 deletions(-)


diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst
--- a/Doc/library/asyncio-protocol.rst
+++ b/Doc/library/asyncio-protocol.rst
@@ -535,8 +535,8 @@
    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 @@
 
    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
diff --git a/Lib/asyncio/streams.py b/Lib/asyncio/streams.py
--- a/Lib/asyncio/streams.py
+++ b/Lib/asyncio/streams.py
@@ -21,7 +21,7 @@
     """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,

-- 
Repository URL: http://hg.python.org/cpython


More information about the Python-checkins mailing list