From: Ben Darnell <ben@bendarnell.com>
Date: Sat, 22 Jun 2019 13:42:09 +0000 (-0400)
Subject: gen: Clean up docs for with_timeout
X-Git-Tag: v6.0.3^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=43a67364914366f019ca1c4b06397b791417b707;p=thirdparty%2Ftornado.git

gen: Clean up docs for with_timeout

Mark CancelledError change as 6.0.3
---

diff --git a/tornado/gen.py b/tornado/gen.py
index daed58ae1..7cc7ec785 100644
--- a/tornado/gen.py
+++ b/tornado/gen.py
@@ -559,7 +559,7 @@ def with_timeout(
     If the wrapped `.Future` fails after it has timed out, the exception
     will be logged unless it is either of a type contained in
     ``quiet_exceptions`` (which may be an exception type or a sequence of
-    types), or a ``CancelledError``.
+    types), or an ``asyncio.CancelledError``.
 
     The wrapped `.Future` is not canceled when the timeout expires,
     permitting it to be reused. `asyncio.wait_for` is similar to this
@@ -574,8 +574,8 @@ def with_timeout(
     .. versionchanged:: 4.4
        Added support for yieldable objects other than `.Future`.
 
-    .. versionchanged:: 6.1
-       Do not log CancelledError after timeout.
+    .. versionchanged:: 6.0.3
+       ``asyncio.CancelledError`` is now always considered "quiet".
 
     """
     # It's tempting to optimize this by cancelling the input future on timeout