Skip to content

Commit f526d10

Browse files
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". (cherry picked from commit f9bf015) Co-authored-by: Volker-Weissmann <[email protected]>
1 parent 58f59a9 commit f526d10

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Doc/library/multiprocessing.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2163,7 +2163,8 @@ with the :class:`Pool` class.
21632163

21642164
.. method:: apply_async(func[, args[, kwds[, callback[, error_callback]]]])
21652165

2166-
A variant of the :meth:`apply` method which returns a result object.
2166+
A variant of the :meth:`apply` method which returns a
2167+
:class:`~multiprocessing.pool.AsyncResult` object.
21672168

21682169
If *callback* is specified then it should be a callable which accepts a
21692170
single argument. When the result becomes ready *callback* is applied to
@@ -2193,7 +2194,8 @@ with the :class:`Pool` class.
21932194

21942195
.. method:: map_async(func, iterable[, chunksize[, callback[, error_callback]]])
21952196

2196-
A variant of the :meth:`.map` method which returns a result object.
2197+
A variant of the :meth:`.map` method which returns a
2198+
:class:`~multiprocessing.pool.AsyncResult` object.
21972199

21982200
If *callback* is specified then it should be a callable which accepts a
21992201
single argument. When the result becomes ready *callback* is applied to

0 commit comments

Comments
 (0)