From: Bram <cortex@worlddomination.be>
Date: Tue, 11 Sep 2018 18:45:26 +0000 (+0200)
Subject: bpo-34613: document the correct value of limit argument of asyncio.StreamReader ... 
X-Git-Tag: v3.8.0a1~1051
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b4ec36200a959da70eba94c19826446a8efdffdd;p=python

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 -->
---

diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst
index 3fe7ac7b4a..27b5205f1c 100644
--- a/Doc/library/asyncio-stream.rst
+++ b/Doc/library/asyncio-stream.rst
@@ -146,10 +146,12 @@ and work with streams:
 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.