]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-34613: document the correct value of limit argument of asyncio.StreamReader ...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 11 Sep 2018 18:59:29 +0000 (11:59 -0700)
committerGitHub <noreply@github.com>
Tue, 11 Sep 2018 18:59:29 +0000 (11:59 -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 -->
(cherry picked from commit b4ec36200a959da70eba94c19826446a8efdffdd)

Co-authored-by: Bram <cortex@worlddomination.be>
Doc/library/asyncio-stream.rst

index f662e72233372550d0da39849e62bc392654d87c..ca7daabdadd58eb728b88bfdfc277e0a41dd57d1 100644 (file)
@@ -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.