diff options
author | Kojo Idrissa <kojoidrissa@users.noreply.github.com> | 2017-07-02 02:47:56 (GMT) |
---|---|---|
committer | Mariatta <Mariatta@users.noreply.github.com> | 2017-07-02 02:47:56 (GMT) |
commit | 4685e56596f9f332e402c79c913a73b19f4411e1 (patch) | |
tree | 657220e27040c9228767f22f86332002aed516fd | |
parent | 0e0bc8762570277147a09278c829e4a85a331596 (diff) | |
download | cpython-4685e56596f9f332e402c79c913a73b19f4411e1.zip cpython-4685e56596f9f332e402c79c913a73b19f4411e1.tar.gz cpython-4685e56596f9f332e402c79c913a73b19f4411e1.tar.bz2 |
[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 5200a7c7f9ea65a96330c5f276f4acc6ec70854e)
-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 2e1a11b..435eb3b 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -160,11 +160,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 |