Commit 5200a7c7 authored by Kojo Idrissa's avatar Kojo Idrissa Committed by Mariatta

bpo-29933: Improve set_write_buffer_limits description (GH-2262)

Improve the description of the high and low parameters for set_write_buffer_limits.
Also fixed a small grammatical issue.
parent 5ea4c067
......@@ -163,11 +163,17 @@ WriteTransport
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.
If specified, the low-water limit must be less than or equal to the
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
high-water limit is given, the low-water limit defaults to an
implementation-specific value less than or equal to the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment