From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 16 Nov 2021 11:51:19 +0000 (-0800)
Subject: Save a reference for ensure_future and create_task (GH-29163)
X-Git-Tag: v3.10.1~66
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7bac59881969f6054fee12d4e3343b7fa1c43136;p=thirdparty%2FPython%2Fcpython.git

Save a reference for ensure_future and create_task (GH-29163)


Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>
(cherry picked from commit c750adbe6990ee8239b27d5f4591283a06bfe862)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
---

diff --git a/Doc/library/asyncio-future.rst b/Doc/library/asyncio-future.rst
index ef496a23f5cd..3496387c178a 100644
--- a/Doc/library/asyncio-future.rst
+++ b/Doc/library/asyncio-future.rst
@@ -54,6 +54,9 @@ Future Functions
       See also the :func:`create_task` function which is the
       preferred way for creating new Tasks.
 
+      Save a reference to the result of this function, to avoid
+      a task disappearing mid execution.
+
    .. versionchanged:: 3.5.1
       The function accepts any :term:`awaitable` object.
 
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index fb86892547b5..f18b0e347b63 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -274,6 +274,11 @@ Creating Tasks
        task = asyncio.ensure_future(coro())
        ...
 
+   .. important::
+
+      Save a reference to the result of this function, to avoid
+      a task disappearing mid execution.
+
    .. versionadded:: 3.7
 
    .. versionchanged:: 3.8