Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

GH-101777: `queue.rst`: use 2 spaces after a period to be consistent. (#102143)

This commit is contained in:
Owain Davies 2023-02-23 03:21:38 +07:00 committed by GitHub
parent 592f65fdb5
commit 96bf24380e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doc/library/queue.rst
View File

@ -15,7 +15,7 @@ module implements all the required locking semantics.
The module implements three types of queue, which differ only in the order in The module implements three types of queue, which differ only in the order in
which the entries are retrieved. In a :abbr:`FIFO (first-in, first-out)` which the entries are retrieved. In a :abbr:`FIFO (first-in, first-out)`
queue, the first tasks added are the first retrieved. In a queue, the first tasks added are the first retrieved. In a
:abbr:`LIFO (last-in, first-out)` queue, the most recently added entry is :abbr:`LIFO (last-in, first-out)` queue, the most recently added entry is
the first retrieved (operating like a stack). With a priority queue, the first retrieved (operating like a stack). With a priority queue,
the entries are kept sorted (using the :mod:`heapq` module) and the the entries are kept sorted (using the :mod:`heapq` module) and the
@ -57,7 +57,7 @@ The :mod:`queue` module defines the following classes and exceptions:
*maxsize* is less than or equal to zero, the queue size is infinite. *maxsize* is less than or equal to zero, the queue size is infinite.
The lowest valued entries are retrieved first (the lowest valued entry is the The lowest valued entries are retrieved first (the lowest valued entry is the
one that would be returned by ``min(entries)``). A typical pattern for one that would be returned by ``min(entries)``). A typical pattern for
entries is a tuple in the form: ``(priority_number, data)``. entries is a tuple in the form: ``(priority_number, data)``.
If the *data* elements are not comparable, the data can be wrapped in a class If the *data* elements are not comparable, the data can be wrapped in a class
@ -127,8 +127,8 @@ provide the public methods described below.
.. method:: Queue.put(item, block=True, timeout=None) .. method:: Queue.put(item, block=True, timeout=None)
Put *item* into the queue. If optional args *block* is true and *timeout* is Put *item* into the queue. If optional args *block* is true and *timeout* is
``None`` (the default), block if necessary until a free slot is available. If ``None`` (the default), block if necessary until a free slot is available. If
*timeout* is a positive number, it blocks at most *timeout* seconds and raises *timeout* is a positive number, it blocks at most *timeout* seconds and raises
the :exc:`Full` exception if no free slot was available within that time. the :exc:`Full` exception if no free slot was available within that time.
Otherwise (*block* is false), put an item on the queue if a free slot is Otherwise (*block* is false), put an item on the queue if a free slot is
@ -143,7 +143,7 @@ provide the public methods described below.
.. method:: Queue.get(block=True, timeout=None) .. method:: Queue.get(block=True, timeout=None)
Remove and return an item from the queue. If optional args *block* is true and Remove and return an item from the queue. If optional args *block* is true and
*timeout* is ``None`` (the default), block if necessary until an item is available. *timeout* is ``None`` (the default), block if necessary until an item is available.
If *timeout* is a positive number, it blocks at most *timeout* seconds and If *timeout* is a positive number, it blocks at most *timeout* seconds and
raises the :exc:`Empty` exception if no item was available within that time. raises the :exc:`Empty` exception if no item was available within that time.
@ -152,7 +152,7 @@ provide the public methods described below.
Prior to 3.0 on POSIX systems, and for all versions on Windows, if Prior to 3.0 on POSIX systems, and for all versions on Windows, if
*block* is true and *timeout* is ``None``, this operation goes into *block* is true and *timeout* is ``None``, this operation goes into
an uninterruptible wait on an underlying lock. This means that no exceptions an uninterruptible wait on an underlying lock. This means that no exceptions
can occur, and in particular a SIGINT will not trigger a :exc:`KeyboardInterrupt`. can occur, and in particular a SIGINT will not trigger a :exc:`KeyboardInterrupt`.
@ -184,7 +184,7 @@ fully processed by daemon consumer threads.
The count of unfinished tasks goes up whenever an item is added to the queue. The count of unfinished tasks goes up whenever an item is added to the queue.
The count goes down whenever a consumer thread calls :meth:`task_done` to The count goes down whenever a consumer thread calls :meth:`task_done` to
indicate that the item was retrieved and all work on it is complete. When the indicate that the item was retrieved and all work on it is complete. When the
count of unfinished tasks drops to zero, :meth:`join` unblocks. count of unfinished tasks drops to zero, :meth:`join` unblocks.
@ -227,7 +227,7 @@ SimpleQueue Objects
.. method:: SimpleQueue.empty() .. method:: SimpleQueue.empty()
Return ``True`` if the queue is empty, ``False`` otherwise. If empty() Return ``True`` if the queue is empty, ``False`` otherwise. If empty()
returns ``False`` it doesn't guarantee that a subsequent call to get() returns ``False`` it doesn't guarantee that a subsequent call to get()
will not block. will not block.