summaryrefslogtreecommitdiffstats
path: root/Doc/library/asyncio-task.rst
diff options
context:
space:
mode:
authorAndrew Svetlov <andrew.svetlov@gmail.com>2022-03-23 15:43:05 (GMT)
committerGitHub <noreply@github.com>2022-03-23 15:43:05 (GMT)
commit0360e9f34659e7d7f3dae021b82f78452db8c714 (patch)
treef88f12dd56fb3f0cca5557447835c94fbea12cb5 /Doc/library/asyncio-task.rst
parent624e3986fbf8467772e4863b7ec004e65adff619 (diff)
downloadcpython-0360e9f34659e7d7f3dae021b82f78452db8c714.zip
cpython-0360e9f34659e7d7f3dae021b82f78452db8c714.tar.gz
cpython-0360e9f34659e7d7f3dae021b82f78452db8c714.tar.bz2
bpo-46829: Deprecate passing a message into Future.cancel() and Task.cancel() (GH-31840)
After a long deliberation we ended up feeling that the message argument for Future.cancel(), added in 3.9, was a bad idea, so we're deprecating it in 3.11 and plan to remove it in 3.13.
Diffstat (limited to 'Doc/library/asyncio-task.rst')
-rw-r--r--Doc/library/asyncio-task.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 294f5ab..21a4cb582 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -810,8 +810,10 @@ Task Object
.. versionchanged:: 3.9
Added the *msg* parameter.
- .. versionchanged:: 3.11
- The ``msg`` parameter is propagated from cancelled task to its awaiter.
+ .. deprecated-removed:: 3.11 3.14
+ *msg* parameter is ambiguous when multiple :meth:`cancel`
+ are called with different cancellation messages.
+ The argument will be removed.
.. _asyncio_example_task_cancel: