From: Richard Oudkerk <shibturn@gmail.com>
Date: Tue, 2 Jul 2013 11:59:55 +0000 (+0100)
Subject: Issue #14206: Clarify docs for Queue.join_cancel_thread().
X-Git-Tag: v3.4.0a1~341^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d7d3f376dd653ab7534dbdcaae14f49987cbd28d;p=thirdparty%2FPython%2Fcpython.git

Issue #14206: Clarify docs for Queue.join_cancel_thread().
---

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index c591cd071053..03be9284cf4c 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()