File tree Expand file tree Collapse file tree 1 file changed +8
-9
lines changed Expand file tree Collapse file tree 1 file changed +8
-9
lines changed Original file line number Diff line number Diff line change @@ -987,17 +987,16 @@ method. The :meth:`~Event.wait` method blocks until the flag is true.
987
987
988
988
.. method :: wait(timeout=None)
989
989
990
- Block until the internal flag is true. If the internal flag is true on
991
- entry, return immediately. Otherwise, block until another thread calls
992
- :meth: `.set ` to set the flag to true, or until the optional timeout occurs.
990
+ Block as long as the internal flag is false and the timeout, if given,
991
+ has not expired. The return value represents the
992
+ reason that this blocking method returned; ``True `` if returning because
993
+ the internal flag is set to true, or ``False `` if a timeout is not
994
+ ``None `` and the the internal flag did not become true within the given
995
+ wait time.
993
996
994
997
When the timeout argument is present and not ``None ``, it should be a
995
- floating point number specifying a timeout for the operation in seconds
996
- (or fractions thereof).
997
-
998
- This method returns ``True `` if and only if the internal flag has been set to
999
- true, either before the wait call or after the wait starts.
1000
- If a timeout is given and the operation times out, ``False `` will be returned.
998
+ floating point number specifying a timeout for the operation in seconds,
999
+ or fractions thereof.
1001
1000
1002
1001
.. versionchanged :: 3.1
1003
1002
Previously, the method always returned ``None ``.
You can’t perform that action at this time.
0 commit comments