Skip to content

Commit 4e132c4

Browse files
committed
Clarify that Queue.join is unblocked unconditionally
1 parent dc762d7 commit 4e132c4

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Doc/library/queue.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,9 @@ or terminated immediately.
259259
If *immediate* is true, the queue is terminated immediately.
260260
The queue is drained to be completely empty. The count of
261261
unfinished tasks is reduced by number drained but without calling
262-
:meth:`~Queue.task_done`. That then unblocks all callers of
263-
:meth:`~Queue.join`. In addition, blocked callers of
262+
:meth:`~Queue.task_done`. All callers of :meth:`~Queue.join`
263+
are unblocked even if the unfinished tasks is more than zero.
264+
In addition, blocked callers of
264265
:meth:`~Queue.get` are unblocked and will raise :exc:`ShutDown`.
265266

266267
Use caution when using :meth:`~Queue.join` with *immediate* set

0 commit comments

Comments
 (0)