Skip to content

Commit e02ca42

Browse files
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 b4ec362) Co-authored-by: Bram <cortex@worlddomination.be>
1 parent 3e648f8 commit e02ca42

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

Doc/library/asyncio-stream.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,12 @@ Stream functions
126126
StreamReader
127127
============
128128

129-
.. class:: StreamReader(limit=None, loop=None)
129+
.. class:: StreamReader(limit=_DEFAULT_LIMIT, loop=None)
130130

131131
This class is :ref:`not thread safe <asyncio-multithreading>`.
132132

133+
The *limit* argument's default value is set to _DEFAULT_LIMIT which is 2**16 (64 KiB)
134+
133135
.. method:: exception()
134136

135137
Get the exception.

0 commit comments

Comments
 (0)