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

Volker-Weissmann webhook-mailer at python.org
Mon Jul 20 07:26:37 EDT 2020


https://github.com/python/cpython/commit/f9bf0157999cb4adbcfd7e9bf526bfa48601e128
commit: f9bf0157999cb4adbcfd7e9bf526bfa48601e128
branch: master
author: Volker-Weissmann <39418860+Volker-Weissmann at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2020-07-20T04:26:32-07:00
summary:

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".

files:
M Doc/library/multiprocessing.rst

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index 08258a65a89dc..69d6523650386 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



More information about the Python-checkins mailing list