Skip to content

Commit 919da56

Browse files
Gelbpunktfantix
andauthored
Fix docstring of loop.shutdown_default_executor (#535)
Ref: python/cpython@575a253 Signed-off-by: Jens Reidel <[email protected]> Co-authored-by: Fantix King <[email protected]>
1 parent 5c500ee commit 919da56

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

uvloop/loop.pyx

+7-2
Original file line numberDiff line numberDiff line change
@@ -3201,7 +3201,12 @@ cdef class Loop:
32013201

32023202
@cython.iterable_coroutine
32033203
async def shutdown_default_executor(self, timeout=None):
3204-
"""Schedule the shutdown of the default executor."""
3204+
"""Schedule the shutdown of the default executor.
3205+
3206+
The timeout parameter specifies the amount of time the executor will
3207+
be given to finish joining. The default value is None, which means
3208+
that the executor will be given an unlimited amount of time.
3209+
"""
32053210
self._executor_shutdown_called = True
32063211
if self._default_executor is None:
32073212
return
@@ -3214,7 +3219,7 @@ cdef class Loop:
32143219
thread.join(timeout)
32153220

32163221
if thread.is_alive():
3217-
warnings.warn(
3222+
warnings_warn(
32183223
"The executor did not finishing joining "
32193224
f"its threads within {timeout} seconds.",
32203225
RuntimeWarning,

0 commit comments

Comments
 (0)