diff options
| author | Lars Kellogg-Stedman <lars@oddbit.com> | 2022-02-03 23:03:23 -0500 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2022-02-09 16:09:48 +1100 |
| commit | 8f6924c9fb061742039554a3b5840f6e92aff7f2 (patch) | |
| tree | 8a69ff64f2b0f15dfa475b8656cde2c8afaca2e6 /docs/library/uasyncio.rst | |
| parent | 6653856b87a76adc5584bb72b32924719effa970 (diff) | |
docs/library/uasyncio.rst: Fix description of ThreadSafeFlag.wait.
When a task waits on a ThreadSafeFlag (and the wait method returns), the
flag is immediately reset. This was not clear in the documentation, which
appeared to copy the description of the wait method from the Event class.
Signed-off-by: Lars Kellogg-Stedman <lars@oddbit.com>
Diffstat (limited to 'docs/library/uasyncio.rst')
| -rw-r--r-- | docs/library/uasyncio.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/library/uasyncio.rst b/docs/library/uasyncio.rst index 1fc8b53db..a842cc64d 100644 --- a/docs/library/uasyncio.rst +++ b/docs/library/uasyncio.rst @@ -159,7 +159,7 @@ class ThreadSafeFlag .. method:: ThreadSafeFlag.wait() Wait for the flag to be set. If the flag is already set then it returns - immediately. + immediately. The flag is automatically reset upon return from ``wait``. A flag may only be waited on by a single task at a time. |