summaryrefslogtreecommitdiffstats
path: root/Doc/library/threading.rst
diff options
context:
space:
mode:
authorPhil Elson <pelson.pub@gmail.com>2024-02-26 09:53:20 (GMT)
committerGitHub <noreply@github.com>2024-02-26 09:53:20 (GMT)
commit37f5d06b1bf830048c09ed967bb2cda945d56541 (patch)
treedf3bb22aeb0d3ff400f1a252d31151963bc5fd4c /Doc/library/threading.rst
parent915d7dd090387b52f62bdc2f572413bc87297cee (diff)
downloadcpython-37f5d06b1bf830048c09ed967bb2cda945d56541.zip
cpython-37f5d06b1bf830048c09ed967bb2cda945d56541.tar.gz
cpython-37f5d06b1bf830048c09ed967bb2cda945d56541.tar.bz2
Doc: Clarify the return type of Event.wait when timeout is used (GH-104168)
Diffstat (limited to 'Doc/library/threading.rst')
-rw-r--r--Doc/library/threading.rst17
1 files changed, 7 insertions, 10 deletions
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
index 5fbf937..cb51147 100644
--- a/Doc/library/threading.rst
+++ b/Doc/library/threading.rst
@@ -987,18 +987,15 @@ method. The :meth:`~Event.wait` method blocks until the flag is true.
.. method:: wait(timeout=None)
- Block until the internal flag is true. If the internal flag is true on
- entry, return immediately. Otherwise, block until another thread calls
- :meth:`.set` to set the flag to true, or until the optional timeout occurs.
+ Block as long as the internal flag is false and the timeout, if given,
+ has not expired. The return value represents the
+ reason that this blocking method returned; ``True`` if returning because
+ the internal flag is set to true, or ``False`` if a timeout is given and
+ the the internal flag did not become true within the given wait time.
When the timeout argument is present and not ``None``, it should be a
- floating point number specifying a timeout for the operation in seconds
- (or fractions thereof).
-
- This method returns ``True`` if and only if the internal flag has been set to
- true, either before the wait call or after the wait starts, so it will
- always return ``True`` except if a timeout is given and the operation
- times out.
+ floating point number specifying a timeout for the operation in seconds,
+ or fractions thereof.
.. versionchanged:: 3.1
Previously, the method always returned ``None``.