Skip to content

Commit 4e4c314

Browse files
committed
Revert some queues related docs since we should doc them in queues in the future
1 parent 5768d08 commit 4e4c314

File tree

1 file changed

+1
-37
lines changed

1 file changed

+1
-37
lines changed

Doc/library/concurrent.interpreters.rst

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ This module defines the following functions:
227227
Initialize a new (idle) Python interpreter
228228
and return a :class:`Interpreter` object for it.
229229

230-
.. function:: create_queue(maxsize=0, *, unbounditems=UNBOUND)
230+
.. function:: create_queue(maxsize=0)
231231

232232
Initialize a new cross-interpreter queue and return a :class:`Queue`
233233
object for it.
@@ -237,17 +237,6 @@ This module defines the following functions:
237237
size has been reached, until queue items are consumed. If *maxsize* is
238238
less than or equal to zero, the queue size is infinite.
239239

240-
*unbounditems* controls the behavior when the interpreter that put an
241-
item into the queue is destroyed. It can be one of:
242-
243-
* :const:`UNBOUND_ERROR` - raise :exc:`ItemInterpreterDestroyed` when
244-
getting an item from a destroyed interpreter
245-
* :const:`UNBOUND_REMOVE` - automatically remove items when their
246-
original interpreter is destroyed
247-
* :const:`UNBOUND` - return :const:`UNBOUND` in place of the original
248-
item (default)
249-
250-
251240
Interpreter objects
252241
^^^^^^^^^^^^^^^^^^^
253242

@@ -350,24 +339,6 @@ Communicating Between Interpreters
350339
The queue's ID.
351340

352341

353-
.. method:: put(obj, block=True, timeout=None, *, unbounditems=None)
354-
355-
Add the object *obj* to the queue.
356-
357-
This method behaves like :meth:`queue.Queue.put`, with the additional
358-
*unbounditems* parameter. See :func:`create_queue` for details on
359-
the *unbounditems* parameter and its behavior.
360-
361-
362-
.. method:: put_nowait(obj, *, unbounditems=None)
363-
364-
Add the object *obj* to the queue without blocking.
365-
366-
This method behaves like :meth:`queue.Queue.put_nowait`, with the
367-
additional *unbounditems* parameter. See :func:`create_queue` for
368-
details on the *unbounditems* parameter and its behavior.
369-
370-
371342
.. exception:: QueueEmpty
372343

373344
This exception, a subclass of :exc:`queue.Empty`, is raised from
@@ -381,13 +352,6 @@ Communicating Between Interpreters
381352
is full.
382353

383354

384-
.. exception:: ItemInterpreterDestroyed
385-
386-
This exception is raised by :meth:`!Queue.get` and :meth:`!Queue.get_nowait`
387-
when the original interpreter that put an item into the queue has been
388-
destroyed and the queue was created with ``unbounditems=UNBOUND_ERROR``.
389-
390-
391355
Basic usage
392356
-----------
393357

0 commit comments

Comments
 (0)