Skip to content

Commit 53317fd

Browse files
authored
Make non-positional-only argument names match runtime declaration in asyncio.tasks function reference (#155282)
1 parent b2c7b34 commit 53317fd

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

Doc/library/asyncio-task.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -668,12 +668,12 @@ Eager task factory
668668
Shielding from cancellation
669669
===========================
670670

671-
.. awaitablefunction:: shield(aw)
671+
.. awaitablefunction:: shield(arg)
672672

673673
Protect an :ref:`awaitable object <asyncio-awaitables>`
674674
from being :meth:`cancelled <Task.cancel>`.
675675

676-
If *aw* is a coroutine it is automatically scheduled as a Task.
676+
If *arg* is a coroutine it is automatically scheduled as a Task.
677677

678678
The statement::
679679

@@ -714,7 +714,7 @@ Shielding from cancellation
714714
Removed the *loop* parameter.
715715

716716
.. deprecated:: 3.10
717-
Deprecation warning is emitted if *aw* is not Future-like object
717+
Deprecation warning is emitted if *arg* is not Future-like object
718718
and there is no running event loop.
719719

720720

@@ -837,13 +837,13 @@ Timeouts
837837

838838
.. versionadded:: 3.11
839839

840-
.. function:: wait_for(aw, timeout)
840+
.. function:: wait_for(fut, timeout)
841841
:async:
842842

843-
Wait for the *aw* :ref:`awaitable <asyncio-awaitables>`
843+
Wait for the *fut* :ref:`awaitable <asyncio-awaitables>`
844844
to complete with a timeout.
845845

846-
If *aw* is a coroutine it is automatically scheduled as a Task.
846+
If *fut* is a coroutine it is automatically scheduled as a Task.
847847

848848
*timeout* can either be ``None`` or a float or int number of seconds
849849
to wait for. If *timeout* is ``None``, block until the future
@@ -859,7 +859,7 @@ Timeouts
859859
so the total wait time may exceed the *timeout*. If an exception
860860
happens during cancellation, it is propagated.
861861

862-
If the wait is cancelled, the future *aw* is also cancelled.
862+
If the wait is cancelled, the future *fut* is also cancelled.
863863

864864
.. _asyncio_example_waitfor:
865865

@@ -884,8 +884,8 @@ Timeouts
884884
# timeout!
885885

886886
.. versionchanged:: 3.7
887-
When *aw* is cancelled due to a timeout, ``wait_for`` waits
888-
for *aw* to be cancelled. Previously, it raised
887+
When *fut* is cancelled due to a timeout, ``wait_for`` waits
888+
for *fut* to be cancelled. Previously, it raised
889889
:exc:`TimeoutError` immediately.
890890

891891
.. versionchanged:: 3.10
@@ -898,20 +898,20 @@ Timeouts
898898
Waiting primitives
899899
==================
900900

901-
.. function:: wait(aws, *, timeout=None, return_when=ALL_COMPLETED)
901+
.. function:: wait(fs, *, timeout=None, return_when=ALL_COMPLETED)
902902
:async:
903903

904-
Run :class:`~asyncio.Future` and :class:`~asyncio.Task` instances in the *aws*
904+
Run :class:`~asyncio.Future` and :class:`~asyncio.Task` instances in the *fs*
905905
iterable concurrently and block until the condition specified
906906
by *return_when*.
907907

908-
The *aws* iterable must not be empty.
908+
The *fs* iterable must not be empty.
909909

910910
Returns two sets of Tasks/Futures: ``(done, pending)``.
911911

912912
Usage::
913913

914-
done, pending = await asyncio.wait(aws)
914+
done, pending = await asyncio.wait(fs)
915915

916916
*timeout* (a float or int), if specified, can be used to control
917917
the maximum number of seconds to wait before returning.
@@ -943,7 +943,7 @@ Waiting primitives
943943
Unlike :func:`~asyncio.wait_for`, ``wait()`` does not cancel the
944944
futures when a timeout occurs.
945945

946-
If ``wait()`` is cancelled, the futures in *aws* are not cancelled
946+
If ``wait()`` is cancelled, the futures in *fs* are not cancelled
947947
and continue to run.
948948

949949
.. versionchanged:: 3.10
@@ -956,9 +956,9 @@ Waiting primitives
956956
Added support for generators yielding tasks.
957957

958958

959-
.. function:: as_completed(aws, *, timeout=None)
959+
.. function:: as_completed(fs, *, timeout=None)
960960

961-
Run :ref:`awaitable objects <asyncio-awaitables>` in the *aws* iterable
961+
Run :ref:`awaitable objects <asyncio-awaitables>` in the *fs* iterable
962962
concurrently. The returned object can be iterated to obtain the results
963963
of the awaitables as they finish.
964964

@@ -1011,7 +1011,7 @@ Waiting primitives
10111011
Removed the *loop* parameter.
10121012

10131013
.. deprecated:: 3.10
1014-
Deprecation warning is emitted if not all awaitable objects in the *aws*
1014+
Deprecation warning is emitted if not all awaitable objects in the *fs*
10151015
iterable are Future-like objects and there is no running event loop.
10161016

10171017
.. versionchanged:: 3.12

0 commit comments

Comments
 (0)