mirrors/micropython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/uasyncio.rst: Fix description of ThreadSafeFlag.wait.

Browse Source 
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>
This commit is contained in:
Lars Kellogg-Stedman 2022-02-03 23:03:23 -05:00 committed by Damien George
parent 6653856b87
commit 8f6924c9fb
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/library/uasyncio.rst
View File

@ -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.