From 919da5675012b0520efd6cc86677fdb1495acae1 Mon Sep 17 00:00:00 2001 From: Jens Reidel Date: Sun, 15 Oct 2023 19:28:17 +0200 Subject: [PATCH] Fix docstring of loop.shutdown_default_executor (#535) Ref: https://github.com/python/cpython/commit/575a253b5c203e8d2ebfd239ed5a613179f8984f Signed-off-by: Jens Reidel Co-authored-by: Fantix King --- uvloop/loop.pyx | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/uvloop/loop.pyx b/uvloop/loop.pyx index a767c13..b2ae509 100644 --- a/uvloop/loop.pyx +++ b/uvloop/loop.pyx @@ -3201,7 +3201,12 @@ cdef class Loop: @cython.iterable_coroutine async def shutdown_default_executor(self, timeout=None): - """Schedule the shutdown of the default executor.""" + """Schedule the shutdown of the default executor. + + The timeout parameter specifies the amount of time the executor will + be given to finish joining. The default value is None, which means + that the executor will be given an unlimited amount of time. + """ self._executor_shutdown_called = True if self._default_executor is None: return @@ -3214,7 +3219,7 @@ cdef class Loop: thread.join(timeout) if thread.is_alive(): - warnings.warn( + warnings_warn( "The executor did not finishing joining " f"its threads within {timeout} seconds.", RuntimeWarning,