From: Sandro Tosi <sandro.tosi@gmail.com>
Date: Wed, 15 Feb 2012 21:39:52 +0000 (+0100)
Subject: Issue #11836: document multiprocessing.queues.SimpleQueue
X-Git-Tag: v2.7.3rc1~51
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c0b1172459bbc0ca507f6d21809cc421e0800145;p=python

Issue #11836: document multiprocessing.queues.SimpleQueue
---

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index c0f394bbc6..7d9aaf351c 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -464,7 +464,7 @@ primitives like locks.
 For passing messages one can use :func:`Pipe` (for a connection between two
 processes) or a queue (which allows multiple producers and consumers).
 
-The :class:`Queue` and :class:`JoinableQueue` types are multi-producer,
+The :class:`Queue`, :class:`multiprocessing.queues.SimpleQueue` and :class:`JoinableQueue` types are multi-producer,
 multi-consumer FIFO queues modelled on the :class:`Queue.Queue` class in the
 standard library.  They differ in that :class:`Queue` lacks the
 :meth:`~Queue.Queue.task_done` and :meth:`~Queue.Queue.join` methods introduced
@@ -610,6 +610,23 @@ For an example of the usage of queues for interprocess communication see
       exits -- see :meth:`join_thread`.
 
 
+.. class:: multiprocessing.queues.SimpleQueue()
+
+   It is a simplified :class:`Queue` type, very close to a locked :class:`Pipe`.
+
+   .. method:: empty()
+
+      Return ``True`` if the queue is empty, ``False`` otherwise.
+
+   .. method:: get()
+
+      Remove and return an item from the queue.
+
+   .. method:: put(item)
+
+      Put *item* into the queue.
+
+
 .. class:: JoinableQueue([maxsize])
 
    :class:`JoinableQueue`, a :class:`Queue` subclass, is a queue which