From: Itamar Ostricher <itamarost@gmail.com>
Date: Sun, 7 May 2023 01:31:53 +0000 (-0700)
Subject: gh-104254: Document the optional keyword-only "context" argument to Task constructor... 
X-Git-Tag: v3.12.0b1~235
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4ee2068c34bd45eddba7f6a8ee83f62d5b6932fc;p=thirdparty%2FPython%2Fcpython.git

gh-104254: Document the optional keyword-only "context" argument to Task constructor (#104251)

(This was added in 3.11. It was already documented for `create_task()`, but not for `Task()`.)
---

diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index f8727b980669..a46ebc1c3d25 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -1014,7 +1014,7 @@ Introspection
 Task Object
 ===========
 
-.. class:: Task(coro, *, loop=None, name=None)
+.. class:: Task(coro, *, loop=None, name=None, context=None)
 
    A :class:`Future-like <Future>` object that runs a Python
    :ref:`coroutine <coroutine>`.  Not thread-safe.
@@ -1049,9 +1049,10 @@ Task Object
    APIs except :meth:`Future.set_result` and
    :meth:`Future.set_exception`.
 
-   Tasks support the :mod:`contextvars` module.  When a Task
-   is created it copies the current context and later runs its
-   coroutine in the copied context.
+   An optional keyword-only *context* argument allows specifying a
+   custom :class:`contextvars.Context` for the *coro* to run in.
+   If no *context* is provided, the Task copies the current context
+   and later runs its coroutine in the copied context.
 
    .. versionchanged:: 3.7
       Added support for the :mod:`contextvars` module.
@@ -1063,6 +1064,9 @@ Task Object
       Deprecation warning is emitted if *loop* is not specified
       and there is no running event loop.
 
+   .. versionchanged:: 3.11
+      Added the *context* parameter.
+
    .. method:: done()
 
       Return ``True`` if the Task is *done*.