]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
gen: Clean up docs for with_timeout 2683/head
authorBen Darnell <ben@bendarnell.com>
Sat, 22 Jun 2019 13:42:09 +0000 (09:42 -0400)
committerBen Darnell <ben@bendarnell.com>
Sat, 22 Jun 2019 13:55:44 +0000 (09:55 -0400)
Mark CancelledError change as 6.0.3

tornado/gen.py

index daed58ae1f9fd0048746cf9792ae0a6ba0083956..7cc7ec78579b71294ec503fbeba8a5ccb05851f9 100644 (file)
@@ -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