Skip to content

Commit 663f827

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 46634b7 commit 663f827

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
@@ -2173,7 +2173,8 @@ with the :class:`Pool` class.
21732173

21742174
.. method:: apply_async(func[, args[, kwds[, callback[, error_callback]]]])
21752175

2176-
A variant of the :meth:`apply` method which returns a result object.
2176+
A variant of the :meth:`apply` method which returns a
2177+
:class:`~multiprocessing.pool.AsyncResult` object.
21772178

21782179
If *callback* is specified then it should be a callable which accepts a
21792180
single argument. When the result becomes ready *callback* is applied to
@@ -2203,7 +2204,8 @@ with the :class:`Pool` class.
22032204

22042205
.. method:: map_async(func, iterable[, chunksize[, callback[, error_callback]]])
22052206

2206-
A variant of the :meth:`.map` method which returns a result object.
2207+
A variant of the :meth:`.map` method which returns a
2208+
:class:`~multiprocessing.pool.AsyncResult` object.
22072209

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

0 commit comments

Comments
 (0)