]> granicus.if.org Git - python/commitdiff
bpo-34613: document the correct value of limit argument of asyncio.StreamReader ...
authorBram <cortex@worlddomination.be>
Tue, 11 Sep 2018 18:45:26 +0000 (20:45 +0200)
committerMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 11 Sep 2018 18:45:26 +0000 (11:45 -0700)
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 -->

Doc/library/asyncio-stream.rst

index 3fe7ac7b4abc683f9ab1d74864bacdc18a381334..27b5205f1c5b6da0c0bbc868ce93ee548ca83517 100644 (file)
@@ -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.