locks,queues: Add versionchanged docs for #3621

diff --git a/tornado/locks.py b/tornado/locks.py
index d05c921ff933a659734a15dd434d0924961688ca..79d10f760649f7e0ebdb20781944006e1be55107 100644 (file)
--- a/tornado/locks.py
+++ b/tornado/locks.py
@@ -119,6 +119,10 @@ class Condition(_TimeoutGarbageCollector):
 
         Returns a `.Future` that resolves ``True`` if the condition is notified,
         or ``False`` after a timeout.
+
+        .. versionchanged:: 6.6
+           A ``timeout`` argument of zero will either return or raise immediately.
+           Previously, zero was treated equivalent to ``None`` (wait forever).
         """
         waiter: Future[bool] = Future()
         self._waiters.append(waiter)
@@ -231,6 +235,10 @@ class Event:
 
         Returns an awaitable, which raises `tornado.util.TimeoutError` after a
         timeout.
+
+        .. versionchanged:: 6.6
+           A ``timeout`` argument of zero will either return or raise immediately.
+           Previously, zero was treated equivalent to ``None`` (wait forever).
         """
         fut: Future[None] = Future()
         if self._value:
@@ -414,6 +422,10 @@ class Semaphore(_TimeoutGarbageCollector):
 
         Block if the counter is zero and wait for a `.release`. The awaitable
         raises `.TimeoutError` after the deadline.
+
+        .. versionchanged:: 6.6
+           A ``timeout`` argument of zero will either return or raise immediately.
+           Previously, zero was treated equivalent to ``None`` (wait forever).
         """
         waiter: Future[_ReleasingContextManager] = Future()
         if self._value > 0:
@@ -528,6 +540,10 @@ class Lock:
 
         Returns an awaitable, which raises `tornado.util.TimeoutError` after a
         timeout.
+
+        .. versionchanged:: 6.6
+           A ``timeout`` argument of zero will either return or raise immediately.
+           Previously, zero was treated equivalent to ``None`` (wait forever).
         """
         return self._block.acquire(timeout)
 

diff --git a/tornado/queues.py b/tornado/queues.py
index 89403d7a32444b904d269ec08a490701c5cb442a..3eeb13e505489e7908ba5c6dd8705d8267a07a6d 100644 (file)
--- a/tornado/queues.py
+++ b/tornado/queues.py
@@ -193,6 +193,10 @@ class Queue(Generic[_T]):
         scale as `tornado.ioloop.IOLoop.time`, normally `time.time`), or a
         `datetime.timedelta` object for a deadline relative to the
         current time.
+
+        .. versionchanged:: 6.6
+           A ``timeout`` argument of zero will either return or raise immediately.
+           Previously, zero was treated equivalent to ``None`` (wait forever).
         """
         future: Future[None] = Future()
         try:
@@ -240,6 +244,9 @@ class Queue(Generic[_T]):
            ``timedelta`` objects for relative timeouts (consistent
            with other timeouts in Tornado).
 
+        .. versionchanged:: 6.6
+           A ``timeout`` argument of zero will either return or raise immediately.
+           Previously, zero was treated equivalent to ``None`` (wait forever).
         """
         future: Future[_T] = Future()
         try:
@@ -292,6 +299,10 @@ class Queue(Generic[_T]):
 
         Returns an awaitable, which raises `tornado.util.TimeoutError` after a
         timeout.
+
+        .. versionchanged:: 6.6
+           A ``timeout`` argument of zero will either return or raise immediately.
+           Previously, zero was treated equivalent to ``None`` (wait forever).
         """
         return self._finished.wait(timeout)