Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Issue #24885: Update note in docs about stream convenience functions. (Merge 3.5->3.6)

This commit is contained in:
Guido van Rossum 2015-10-19 13:19:08 -07:00
parent 4604580233 460b38151f
commit 77b3d48497
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Doc/library/asyncio-stream.rst
View 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)