Skip to content

Commit 81fd048

Browse files
committed
Improve doc wording, reference methods
1 parent f279f5c commit 81fd048

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Doc/library/queue.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -239,13 +239,15 @@ them down.
239239

240240
.. method:: Queue.shutdown(immediate=False)
241241

242-
Shut-down the queue, making queue gets and puts raise :exc:`ShutDown`.
242+
Shut-down the queue, making :meth:`~Queue.get` and :meth:`~Queue.put` raise
243+
:exc:`ShutDown`.
243244

244-
By default, gets will only raise once the queue is empty. Set
245-
*immediate* to true to make gets raise immediately instead.
245+
By default, :meth:`~Queue.get` on a shut-down queue will only raise once the
246+
queue is empty. Set *immediate* to true to make :meth:`~Queue.get` raise
247+
immediately instead.
246248

247-
All blocked callers of put() will be unblocked, and also get()
248-
and join() if *immediate* is true.
249+
All blocked callers of :meth:`~Queue.put` will be unblocked. If *immediate*
250+
is true, also unblock callers of :meth:`~Queue.get` and :meth:`~Queue.join`.
249251

250252
.. versionadded:: 3.13
251253

0 commit comments

Comments
 (0)