[Python-checkins] cpython (2.7): Issue #14206: Clarify docs for Queue.join_cancel_thread().

[richard.oudkerk]

http://hg.python.org/cpython/rev/f35401dba89f
changeset:   84425:f35401dba89f
branch:      2.7
parent:      84422:389788ba6bcb
user:        Richard Oudkerk <shibturn at gmail.com>
date:        Tue Jul 02 12:58:21 2013 +0100
summary:
  Issue #14206: Clarify docs for Queue.join_cancel_thread().

files:
  Doc/library/multiprocessing.rst |  7 +++++++
  1 files changed, 7 insertions(+), 0 deletions(-)


diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -630,6 +630,13 @@
       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:: multiprocessing.queues.SimpleQueue()
 

-- 
Repository URL: http://hg.python.org/cpython