Skip to content

Commit f5fcdd6

Browse files
committed
Add references in docs and news entry
1 parent dc60eb3 commit f5fcdd6

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

Doc/library/multiprocessing.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -884,14 +884,16 @@ For an example of the usage of queues for interprocess communication see
884884

885885
.. method:: shutdown(immediate=False)
886886

887-
Shut-down the queue, making queue gets and puts raise
888-
:exc:`queue.ShutDown`.
887+
Shut-down the queue, making :meth:`~Queue.get` and :meth:`~Queue.put`
888+
raise :exc:`queue.ShutDown`.
889889

890-
By default, gets will only raise once the queue is empty. Set
891-
*immediate* to true to make gets raise immediately instead.
890+
By default, :meth:`~Queue.get` on a shut down queue will only raise once
891+
the queue is empty. Set *immediate* to true to make :meth:`~Queue.get`
892+
raise immediately instead.
892893

893-
All blocked callers of put() will be unblocked, and also get()
894-
and join() if *immediate* is true.
894+
All blocked callers of :meth:`~Queue.put` will be unblocked. If
895+
*immediate* is true, also unblock callers of :meth:`~Queue.get` and
896+
:meth:`~Queue.join`.
895897

896898
.. versionadded:: 3.13
897899

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
Add :class:`multiprocessing.Queue` and :class:`multiprocessing.JoinableQueue` termination with ``shutdown`` method.
1+
Add :class:`multiprocessing.Queue` and :class:`multiprocessing.JoinableQueue`
2+
termination with :py:meth:`~multiprocessing.Queue.shutdown` method.

0 commit comments

Comments
 (0)