From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 11 Sep 2018 18:59:29 +0000 (-0700)
Subject: bpo-34613: document the correct value of limit argument of asyncio.StreamReader ... 
X-Git-Tag: v3.7.1rc1~91
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e02ca4270ef258162215e345c23025bec27f9eb0;p=thirdparty%2FPython%2Fcpython.git

bpo-34613: document the correct value of limit argument of asyncio.StreamReader (GH-9121)


The default value of asyncio.StreamReader *limit* is `_DEFAULT_LIMIT` instead of `None`.

<!-- issue-number: [bpo-34613](https://www.bugs.python.org/issue34613) -->
https://bugs.python.org/issue34613
<!-- /issue-number -->
(cherry picked from commit b4ec36200a959da70eba94c19826446a8efdffdd)

Co-authored-by: Bram <cortex@worlddomination.be>
---

diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst
index f662e7223337..ca7daabdadd5 100644
--- a/Doc/library/asyncio-stream.rst
+++ b/Doc/library/asyncio-stream.rst
@@ -126,10 +126,12 @@ Stream functions
 StreamReader
 ============
 
-.. class:: StreamReader(limit=None, loop=None)
+.. class:: StreamReader(limit=_DEFAULT_LIMIT, loop=None)
 
    This class is :ref:`not thread safe <asyncio-multithreading>`.
 
+   The *limit* argument's default value is set to _DEFAULT_LIMIT which is 2**16 (64 KiB)
+
    .. method:: exception()
 
       Get the exception.