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

This commit is contained in:
Richard Oudkerk 2013-07-02 13:01:31 +01:00
commit 771b961d4e
1 changed files with 7 additions and 0 deletions

View File

@ -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()