summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVolker-Weissmann <39418860+Volker-Weissmann@users.noreply.github.com>2020-07-20 13:26:32 +0200
committerGitHub <noreply@github.com>2020-07-20 04:26:32 -0700
commitf9bf0157999cb4adbcfd7e9bf526bfa48601e128 (patch)
tree7e0dc9d139cc65f0be66861a9dcf09e399e88018
parentd42528a3a2c7d79fd2e6c9f2a02f3ce12d44c8cc (diff)
downloadcpython-git-f9bf0157999cb4adbcfd7e9bf526bfa48601e128.tar.gz
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".
-rw-r--r--Doc/library/multiprocessing.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index 08258a65a8..69d6523650 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