]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Simple Documentation fix: Missing link to return type class. (GH-21291)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 20 Jul 2020 11:35:11 +0000 (04:35 -0700)
committerGitHub <noreply@github.com>
Mon, 20 Jul 2020 11:35:11 +0000 (04:35 -0700)
Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
(cherry picked from commit f9bf0157999cb4adbcfd7e9bf526bfa48601e128)

Co-authored-by: Volker-Weissmann <39418860+Volker-Weissmann@users.noreply.github.com>
Doc/library/multiprocessing.rst

index ec9521f1fb4a0cc7229bb6332508b63e946d987d..bb3ee87a4403a047c41c320ec77ead083de0b357 100644 (file)
@@ -2163,7 +2163,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
@@ -2193,7 +2194,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