From a05330b8d3ab8898b8c55dacda739791b811aac0 Mon Sep 17 00:00:00 2001 From: Kojo Idrissa Date: Sat, 17 Jun 2017 21:09:24 -0500 Subject: [PATCH 1/4] addressing issue29933#msg290712 --- Doc/library/asyncio-protocol.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 3f55506c669a29f..57ebba0f06b648d 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -163,11 +163,14 @@ 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 From 5a9dee1c65293e8f25cedcfbd383b119f00c71cb Mon Sep 17 00:00:00 2001 From: Kojo Idrissa Date: Sat, 17 Jun 2017 21:21:04 -0500 Subject: [PATCH 2/4] fixed line length issue --- Doc/library/asyncio-protocol.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 57ebba0f06b648d..e019e6b3c3ff820 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -169,7 +169,10 @@ WriteTransport 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. + :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 From e8209d6326726c004f00629c423d84879ee0a822 Mon Sep 17 00:00:00 2001 From: Kojo Idrissa Date: Sat, 17 Jun 2017 22:53:29 -0500 Subject: [PATCH 3/4] removed trailing space --- Doc/library/asyncio-protocol.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index e019e6b3c3ff820..520d203ee6d6540 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -170,7 +170,7 @@ WriteTransport 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, + 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. From 4f1e8ed93dce5b986de84e670c35e702b3a6d971 Mon Sep 17 00:00:00 2001 From: Kojo Idrissa Date: Sat, 17 Jun 2017 23:24:25 -0500 Subject: [PATCH 4/4] removed another trailing space --- Doc/library/asyncio-protocol.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 520d203ee6d6540..dfe37c239d6b391 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -169,7 +169,7 @@ WriteTransport 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 + :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.