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