Simple Documentation fix: Missing link to return type class. (GH-21291)
https://github.com/python/cpython/commit/f526d10267e8c0d20b3f5584eb7ca671f3a... commit: f526d10267e8c0d20b3f5584eb7ca671f3a526df branch: 3.8 author: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> committer: GitHub <noreply@github.com> date: 2020-07-20T04:35:11-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". (cherry picked from commit f9bf0157999cb4adbcfd7e9bf526bfa48601e128) Co-authored-by: Volker-Weissmann <39418860+Volker-Weissmann@users.noreply.github.com> files: M Doc/library/multiprocessing.rst diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index ec9521f1fb4a0..bb3ee87a4403a 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -2163,7 +2163,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 @@ -2193,7 +2194,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
participants (1)
-
Miss Islington (bot)