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

[guido.van.rossum]

https://hg.python.org/cpython/rev/43c63dd2f383
changeset:   98798:43c63dd2f383
branch:      3.5
parent:      98795:f30a4a443a19
parent:      98797:d91208957e4e
user:        Guido van Rossum <guido at python.org>
date:        Mon Oct 19 13:18:40 2015 -0700
summary:
  Issue #24885: Update note in docs about stream convenience functions. (Merge 3.4->3.5)

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