]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Issue #24885: Update note in docs about stream convenience functions.
authorGuido van Rossum <guido@python.org>
Mon, 19 Oct 2015 20:18:04 +0000 (13:18 -0700)
committerGuido van Rossum <guido@python.org>
Mon, 19 Oct 2015 20:18:04 +0000 (13:18 -0700)
Doc/library/asyncio-stream.rst

index 22a4631479ab9363cc4bb3a761a1b62a166b79e5..171fd86276204541819e8459735c64d189eb93e2 100644 (file)
@@ -9,6 +9,13 @@ Streams (high-level API)
 Stream functions
 ================
 
+.. note::
+
+   The top-level functions in this module are meant convenience wrappers
+   only; there's really nothing special there, and if they don't do
+   exactly what you want, feel free to copy their code.
+
+
 .. coroutinefunction:: open_connection(host=None, port=None, \*, loop=None, limit=None, \*\*kwds)
 
    A wrapper for :meth:`~BaseEventLoop.create_connection()` returning a (reader,
@@ -26,10 +33,6 @@ Stream functions
    instance to use) and *limit* (to set the buffer limit passed to the
    :class:`StreamReader`).
 
-   (If you want to customize the :class:`StreamReader` and/or
-   :class:`StreamReaderProtocol` classes, just copy the code -- there's really
-   nothing special here except some convenience.)
-
    This function is a :ref:`coroutine <coroutine>`.
 
 .. coroutinefunction:: start_server(client_connected_cb, host=None, port=None, \*, loop=None, limit=None, \*\*kwds)