From 19ff6977a7859e01678a49700bed23a3a77e6355 Mon Sep 17 00:00:00 2001 From: Guido van Rossum Date: Mon, 19 Oct 2015 13:18:04 -0700 Subject: [PATCH] Issue #24885: Update note in docs about stream convenience functions. --- Doc/library/asyncio-stream.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst index 22a4631479a..171fd862762 100644 --- a/Doc/library/asyncio-stream.rst +++ b/Doc/library/asyncio-stream.rst @@ -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 `. .. coroutinefunction:: start_server(client_connected_cb, host=None, port=None, \*, loop=None, limit=None, \*\*kwds)