Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 19ff697

Browse files
committed
Issue #24885: Update note in docs about stream convenience functions.
1 parent 06d48db commit 19ff697

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

Doc/library/asyncio-stream.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ Streams (high-level API)
99
Stream functions
1010
================
1111

12+
.. note::
13+
14+
The top-level functions in this module are meant convenience wrappers
15+
only; there's really nothing special there, and if they don't do
16+
exactly what you want, feel free to copy their code.
17+
18+
1219
.. coroutinefunction:: open_connection(host=None, port=None, \*, loop=None, limit=None, \*\*kwds)
1320

1421
A wrapper for :meth:`~BaseEventLoop.create_connection()` returning a (reader,
@@ -26,10 +33,6 @@ Stream functions
2633
instance to use) and *limit* (to set the buffer limit passed to the
2734
:class:`StreamReader`).
2835

29-
(If you want to customize the :class:`StreamReader` and/or
30-
:class:`StreamReaderProtocol` classes, just copy the code -- there's really
31-
nothing special here except some convenience.)
32-
3336
This function is a :ref:`coroutine <coroutine>`.
3437

3538
.. coroutinefunction:: start_server(client_connected_cb, host=None, port=None, \*, loop=None, limit=None, \*\*kwds)

0 commit comments

Comments
 (0)