From: Doug Hoskisson <beauxq@users.noreply.github.com>
Date: Tue, 14 Oct 2025 08:34:53 +0000 (-0700)
Subject: gh-114827: clarify `threading.Event.wait` timeout behavior (#114834)
X-Git-Tag: v3.15.0a1~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=13e9c2d18de26a590f9b11b1add637200bf66dd1;p=thirdparty%2FPython%2Fcpython.git

gh-114827: clarify `threading.Event.wait` timeout behavior (#114834)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
---

diff --git a/Lib/threading.py b/Lib/threading.py
index fac88d8b20c6..4ebceae70298 100644
--- a/Lib/threading.py
+++ b/Lib/threading.py
@@ -653,7 +653,8 @@ class Event:
         (or fractions thereof).
 
         This method returns the internal flag on exit, so it will always return
-        True except if a timeout is given and the operation times out.
+        ``True`` except if a timeout is given and the operation times out, when
+        it will return ``False``.
 
         """
         with self._cond: