Skip to content

Commit 81e3e82

Browse files
committed
Doc: Clarify the return type of Event.wait when timeout is used.
1 parent ef0df52 commit 81e3e82

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Doc/library/threading.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -989,7 +989,7 @@ method. The :meth:`~Event.wait` method blocks until the flag is true.
989989

990990
When the timeout argument is present and not ``None``, it should be a
991991
floating point number specifying a timeout for the operation in seconds
992-
(or fractions thereof).
992+
(or fractions thereof). When the timeout occurs, ``False`` will be returned.
993993

994994
This method returns ``True`` if and only if the internal flag has been set to
995995
true, either before the wait call or after the wait starts, so it will

0 commit comments

Comments
 (0)