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 fac88d8b20c60da2cc92ff088e5f6059bfc47b84..4ebceae70298700a257613ec988ab3e8272ef457 100644 (file)
--- 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: