summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>2015-10-19 20:18:40 (GMT)
committerGuido van Rossum <guido@python.org>2015-10-19 20:18:40 (GMT)
commit460b38151f4eb9302adac022166acadf6e4a221f (patch)
tree06bad05689bdee0852a9b43f2ec9f17b78b5669d /Doc
parent25c578d0a6b5ad9f59fbc859cd747e8bbaffc063 (diff)
parent19ff6977a7859e01678a49700bed23a3a77e6355 (diff)
downloadcpython-460b38151f4eb9302adac022166acadf6e4a221f.zip
cpython-460b38151f4eb9302adac022166acadf6e4a221f.tar.gz
cpython-460b38151f4eb9302adac022166acadf6e4a221f.tar.bz2
Issue #24885: Update note in docs about stream convenience functions. (Merge 3.4->3.5)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/asyncio-stream.rst11
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)