mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-02 05:12:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.6] bpo-29933: Improve set_write_buffer_limits description (GH-2262) (GH-2532)

Browse source 
Improve the description of the high and low parameters for set_write_buffer_limits.
Also fixed a small grammatical issue.
(cherry picked from commit 5200a7c7f9)
This commit is contained in:
Kojo Idrissa 2017-07-02 11:48:07 +09:00 • committed by Mariatta
parent 3024c05290
commit 03af428242
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/library/asyncio-protocol.rst
View file

@ -163,11 +163,17 @@ WriteTransport
Set the *high*- and *low*-water limits for write flow control. Set the *high*- and *low*-water limits for write flow control.
These two values control when call the protocol's These two values (measured in number of
bytes) control when the protocol's
:meth:`pause_writing` and :meth:`resume_writing` methods are called. :meth:`pause_writing` and :meth:`resume_writing` methods are called.
If specified, the low-water limit must be less than or equal to the If specified, the low-water limit must be less than or equal to the
high-water limit. Neither *high* nor *low* can be negative. high-water limit. Neither *high* nor *low* can be negative.
:meth:`pause_writing` is called when the buffer size becomes greater
than or equal to the *high* value. If writing has been paused,
:meth:`resume_writing` is called when the buffer size becomes less
than or equal to the *low* value.
The defaults are implementation-specific. If only the The defaults are implementation-specific. If only the
high-water limit is given, the low-water limit defaults to an high-water limit is given, the low-water limit defaults to an
implementation-specific value less than or equal to the implementation-specific value less than or equal to the