From d7d3f376dd653ab7534dbdcaae14f49987cbd28d Mon Sep 17 00:00:00 2001 From: Richard Oudkerk Date: Tue, 2 Jul 2013 12:59:55 +0100 Subject: [PATCH] Issue #14206: Clarify docs for Queue.join_cancel_thread(). --- Doc/library/multiprocessing.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index c591cd07105..03be9284cf4 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -659,6 +659,13 @@ For an example of the usage of queues for interprocess communication see the background thread from being joined automatically when the process exits -- see :meth:`join_thread`. + A better name for this method might be + ``allow_exit_without_flush()``. It is likely to cause enqueued + data to lost, and you almost certainly will not need to use it. + It is really only there if you need the current process to exit + immediately without waiting to flush enqueued data to the + underlying pipe, and you don't care about lost data. + .. class:: SimpleQueue()