Browse Source
BPO-42703: Fix incorrect documentation links for asyncio.Event (GH-23881)
pull/23913/head
Matt Fowler
5 years ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with
5 additions and
5 deletions
-
Doc/library/asyncio-sync.rst
|
|
|
@ -101,8 +101,8 @@ Event |
|
|
|
that some event has happened. |
|
|
|
|
|
|
|
An Event object manages an internal flag that can be set to *true* |
|
|
|
with the :meth:`set` method and reset to *false* with the |
|
|
|
:meth:`clear` method. The :meth:`wait` method blocks until the |
|
|
|
with the :meth:`~Event.set` method and reset to *false* with the |
|
|
|
:meth:`clear` method. The :meth:`~Event.wait` method blocks until the |
|
|
|
flag is set to *true*. The flag is set to *false* initially. |
|
|
|
|
|
|
|
.. _asyncio_example_sync_event: |
|
|
|
@ -135,7 +135,7 @@ Event |
|
|
|
Wait until the event is set. |
|
|
|
|
|
|
|
If the event is set, return ``True`` immediately. |
|
|
|
Otherwise block until another task calls :meth:`set`. |
|
|
|
Otherwise block until another task calls :meth:`~Event.set`. |
|
|
|
|
|
|
|
.. method:: set() |
|
|
|
|
|
|
|
@ -148,8 +148,8 @@ Event |
|
|
|
|
|
|
|
Clear (unset) the event. |
|
|
|
|
|
|
|
Tasks awaiting on :meth:`wait` will now block until the |
|
|
|
:meth:`set` method is called again. |
|
|
|
Tasks awaiting on :meth:`~Event.wait` will now block until the |
|
|
|
:meth:`~Event.set` method is called again. |
|
|
|
|
|
|
|
.. method:: is_set() |
|
|
|
|
|
|
|
|