[Python-checkins] cpython (3.4): Issue #24885: Update note in docs about stream convenience functions.

Mon Oct 19 16:20:01 EDT 2015

https://hg.python.org/cpython/rev/d91208957e4e
changeset: 98797:d91208957e4e
branch: 3.4
parent: 98794:10ec45123dae
user: Guido van Rossum <guido at python.org>
date: Mon Oct 19 13:18:04 2015 -0700
summary:
 Issue #24885: Update note in docs about stream convenience functions.
files:
 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
--- a/Doc/library/asyncio-stream.rst
+++ b/Doc/library/asyncio-stream.rst
@@ -9,6 +9,13 @@
 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 @@
 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)
-- 
Repository URL: https://hg.python.org/cpython
