From: Volker-Weissmann <39418860+Volker-Weissmann@users.noreply.github.com>
Date: Mon, 20 Jul 2020 11:26:32 +0000 (+0200)
Subject: Simple Documentation fix: Missing link to return type class. (GH-21291)
X-Git-Tag: v3.10.0a1~365
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f9bf0157999cb4adbcfd7e9bf526bfa48601e128;p=thirdparty%2FPython%2Fcpython.git

Simple Documentation fix: Missing link to return type class. (GH-21291)



Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
---

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index 08258a65a89d..69d652365038 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -2173,7 +2173,8 @@ with the :class:`Pool` class.
 
    .. method:: apply_async(func[, args[, kwds[, callback[, error_callback]]]])
 
-      A variant of the :meth:`apply` method which returns a result object.
+      A variant of the :meth:`apply` method which returns a
+      :class:`~multiprocessing.pool.AsyncResult` object.
 
       If *callback* is specified then it should be a callable which accepts a
       single argument.  When the result becomes ready *callback* is applied to
@@ -2203,7 +2204,8 @@ with the :class:`Pool` class.
 
    .. method:: map_async(func, iterable[, chunksize[, callback[, error_callback]]])
 
-      A variant of the :meth:`.map` method which returns a result object.
+      A variant of the :meth:`.map` method which returns a
+      :class:`~multiprocessing.pool.AsyncResult` object.
 
       If *callback* is specified then it should be a callable which accepts a
       single argument.  When the result becomes ready *callback* is applied to