diff options
| author | Bram <cortex@worlddomination.be> | 2018-09-11 18:45:26 (GMT) |
|---|---|---|
| committer | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2018-09-11 18:45:26 (GMT) |
| commit | b4ec36200a959da70eba94c19826446a8efdffdd (patch) | |
| tree | 3a14c00c9fbece7db9e00ba3876dd9567b3a655d | |
| parent | b7d613fc5636d5d8c5ec32d8004c095e20cc4d7d (diff) | |
| download | cpython-b4ec36200a959da70eba94c19826446a8efdffdd.zip cpython-b4ec36200a959da70eba94c19826446a8efdffdd.tar.gz cpython-b4ec36200a959da70eba94c19826446a8efdffdd.tar.bz2 | |
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 -->
| -rw-r--r-- | Doc/library/asyncio-stream.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst index 3fe7ac7..27b5205 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. |