Skip to content

Commit

Permalink
Simple Documentation fix: Missing link to return type class. (GH-21291)
Browse files Browse the repository at this point in the history
Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
  • Loading branch information
Volker-Weissmann authored Jul 20, 2020
1 parent d42528a commit f9bf015
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions Doc/library/multiprocessing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit f9bf015

Please sign in to comment.