diff options
| author | Guido van Rossum <guido@dropbox.com> | 2015-10-19 20:19:08 (GMT) |
|---|---|---|
| committer | Guido van Rossum <guido@dropbox.com> | 2015-10-19 20:19:08 (GMT) |
| commit | 77b3d484973c9ee379688636f93f43e60585ebf6 (patch) | |
| tree | 5296af98e20349c058d4d93d7c583b353bf3360f /Doc | |
| parent | 4604580233c5e66eac2cd62ac05fad5b1912e0b4 (diff) | |
| parent | 460b38151f4eb9302adac022166acadf6e4a221f (diff) | |
| download | cpython-77b3d484973c9ee379688636f93f43e60585ebf6.zip cpython-77b3d484973c9ee379688636f93f43e60585ebf6.tar.gz cpython-77b3d484973c9ee379688636f93f43e60585ebf6.tar.bz2 | |
Issue #24885: Update note in docs about stream convenience functions. (Merge 3.5->3.6)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/asyncio-stream.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst index 22a4631..171fd86 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 <coroutine>`. .. coroutinefunction:: start_server(client_connected_cb, host=None, port=None, \*, loop=None, limit=None, \*\*kwds) |