From 85672bddebb53558c9e5bdf18d5dbc1f24aa3816 Mon Sep 17 00:00:00 2001 From: Daniil Fajnberg Date: Thu, 5 May 2022 08:46:27 +0200 Subject: [PATCH] Add short docstring to `until_closed` method --- src/asyncio_taskpool/pool.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/asyncio_taskpool/pool.py b/src/asyncio_taskpool/pool.py index 4b33ba7..58a1c71 100644 --- a/src/asyncio_taskpool/pool.py +++ b/src/asyncio_taskpool/pool.py @@ -553,6 +553,12 @@ class BaseTaskPool: self._closed.set() async def until_closed(self) -> bool: + """ + Waits until the pool has been closed. (This method itself does **not** close the pool, but blocks until then.) + + Returns: + `True` once the pool is closed. + """ return await self._closed.wait()