Skip to content

Commit 02a6c0f

Browse files
authored
commit 2
1 parent fc22f58 commit 02a6c0f

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

Doc/library/asyncio-queue.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ asyncio queues are designed to be similar to classes of the
1515
they are designed to be used specifically in async/await code.
1616

1717
Note that methods of asyncio queues don't have a *timeout* parameter;
18-
use :func:`asyncio.wait_for` function to do queue operations with a
19-
timeout.
18+
use :func:`asyncio.wait_for` function to perform queue operations with a
19+
timeouts.
2020

2121
See also the `Examples`_ section below.
2222

@@ -55,7 +55,8 @@ Queue
5555
Return ``True`` if there are :attr:`maxsize` items in the queue.
5656

5757
If the queue was initialized with ``maxsize=0`` (the default),
58-
then :meth:`full` never returns ``True``.
58+
or a negative :attr:`maxsize:, then :meth:`full` never returns
59+
``True``.
5960

6061
.. method:: get()
6162
:async:
@@ -109,7 +110,7 @@ Queue
109110
Currently blocked callers of :meth:`~Queue.put` will be unblocked
110111
and will raise :exc:`QueueShutDown` in the formerly awaiting task.
111112

112-
If *immediate* is false (the default), the queue can be wound
113+
If *immediate* is ``False`` (the default), the queue can be wound
113114
down normally with :meth:`~Queue.get` calls to extract tasks
114115
that have already been loaded.
115116

@@ -119,17 +120,17 @@ Queue
119120
Once the queue is empty, future calls to :meth:`~Queue.get` will
120121
raise :exc:`QueueShutDown`.
121122

122-
If *immediate* is true, the queue is terminated immediately.
123+
If *immediate* is ``True``, the queue is terminated immediately.
123124
The queue is drained to be completely empty and the count
124125
of unfinished tasks is reduced by the number of tasks drained.
125-
If unfinished tasks is zero, callers of :meth:`~Queue.join`
126-
are unblocked. Also, blocked callers of :meth:`~Queue.get`
127-
are unblocked and will raise :exc:`QueueShutDown` because the
126+
If the count reaches zero, callers of :meth:`~Queue.join` are
127+
unblocked. Also, blocked callers of :meth:`~Queue.get` are
128+
unblocked and will raise :exc:`QueueShutDown` because the
128129
queue is empty.
129130

130-
Use caution when using :meth:`~Queue.join` with *immediate* set
131-
to true. This unblocks the join even when no work has been done
132-
on the tasks, violating the usual invariant for joining a queue.
131+
Exercise caution when using :meth:`~Queue.join` in the above case.
132+
The join may be unblocked even when no work has been done on the
133+
tasks, violating the usual invariant for joining a queue.
133134

134135
.. versionadded:: 3.13
135136

0 commit comments

Comments
 (0)