[3.14] gh-114827: clarify `threading.Event.wait` timeout behavior (GH-114834) (#140100)

Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>

diff --git a/Lib/threading.py b/Lib/threading.py
index 79b753d983aaaf8e684a765d887b049dc5429cb9..c03b0b5370c933680bd04c8934d17dfa211bbf54 100644 (file)
--- a/Lib/threading.py
+++ b/Lib/threading.py
@@ -660,7 +660,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: