diff options
| author | Richard Oudkerk <shibturn@gmail.com> | 2013-07-02 11:59:55 (GMT) |
|---|---|---|
| committer | Richard Oudkerk <shibturn@gmail.com> | 2013-07-02 11:59:55 (GMT) |
| commit | d7d3f376dd653ab7534dbdcaae14f49987cbd28d (patch) | |
| tree | 0458891f08b759bd8569d92410a3869fa47281cc | |
| parent | b3c4b98c237359247d3e09d0738d308a456994a5 (diff) | |
| download | cpython-d7d3f376dd653ab7534dbdcaae14f49987cbd28d.zip cpython-d7d3f376dd653ab7534dbdcaae14f49987cbd28d.tar.gz cpython-d7d3f376dd653ab7534dbdcaae14f49987cbd28d.tar.bz2 | |
Issue #14206: Clarify docs for Queue.join_cancel_thread().
| -rw-r--r-- | Doc/library/multiprocessing.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index c591cd0..03be928 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() |