bpo-29933: Improve set_write_buffer_limits description (GH-2262) · python/cpython@5200a7c

Original file line numberDiff line numberDiff line change

@@ -163,11 +163,17 @@ WriteTransport

163163
164164

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

165165
166-

These two values control when call the protocol's

166+

These two values (measured in number of

167+

bytes) control when the protocol's

167168

:meth:`pause_writing` and :meth:`resume_writing` methods are called.

168169

If specified, the low-water limit must be less than or equal to the

169170

high-water limit. Neither *high* nor *low* can be negative.

170171
172+

:meth:`pause_writing` is called when the buffer size becomes greater

173+

than or equal to the *high* value. If writing has been paused,

174+

:meth:`resume_writing` is called when the buffer size becomes less

175+

than or equal to the *low* value.

176+
171177

The defaults are implementation-specific. If only the

172178

high-water limit is given, the low-water limit defaults to an

173179

implementation-specific value less than or equal to the