Skip to content

Commit 4685e56

Browse files
kojoidrissaMariatta
authored andcommitted
[3.5] bpo-29933: Improve set_write_buffer_limits description (GH-2262) (GH-2533)
Improve the description of the high and low parameters for set_write_buffer_limits. Also fixed a small grammatical issue. (cherry picked from commit 5200a7c)
1 parent 0e0bc87 commit 4685e56

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

Doc/library/asyncio-protocol.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,11 +160,17 @@ WriteTransport
160160

161161
Set the *high*- and *low*-water limits for write flow control.
162162

163-
These two values control when call the protocol's
163+
These two values (measured in number of
164+
bytes) control when the protocol's
164165
:meth:`pause_writing` and :meth:`resume_writing` methods are called.
165166
If specified, the low-water limit must be less than or equal to the
166167
high-water limit. Neither *high* nor *low* can be negative.
167168

169+
:meth:`pause_writing` is called when the buffer size becomes greater
170+
than or equal to the *high* value. If writing has been paused,
171+
:meth:`resume_writing` is called when the buffer size becomes less
172+
than or equal to the *low* value.
173+
168174
The defaults are implementation-specific. If only the
169175
high-water limit is given, the low-water limit defaults to an
170176
implementation-specific value less than or equal to the

0 commit comments

Comments
 (0)