diff options
author | Kojo Idrissa <kojoidrissa@users.noreply.github.com> | 2017-06-20 19:32:00 (GMT) |
---|---|---|
committer | Mariatta <Mariatta@users.noreply.github.com> | 2017-06-20 19:32:00 (GMT) |
commit | 5200a7c7f9ea65a96330c5f276f4acc6ec70854e (patch) | |
tree | 5c44f56b9437a00e59a7913a0205c52752527a0a /Doc | |
parent | 5ea4c0677389ead2eee759958694cff2c65834a7 (diff) | |
download | cpython-5200a7c7f9ea65a96330c5f276f4acc6ec70854e.zip cpython-5200a7c7f9ea65a96330c5f276f4acc6ec70854e.tar.gz cpython-5200a7c7f9ea65a96330c5f276f4acc6ec70854e.tar.bz2 |
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.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/asyncio-protocol.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 3f55506..dfe37c2 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -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 |