diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2020-07-20 11:33:19 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-20 11:33:19 (GMT) |
| commit | 663f827341caa272be7c3dce6156f1a76f5cc64d (patch) | |
| tree | a2f373b45dbe85caf4fa9e0b4e9142ef283c6ac8 /Doc/library | |
| parent | 46634b7aa82f014cd0039afb7f0ed860605beb9d (diff) | |
| download | cpython-663f827341caa272be7c3dce6156f1a76f5cc64d.zip cpython-663f827341caa272be7c3dce6156f1a76f5cc64d.tar.gz cpython-663f827341caa272be7c3dce6156f1a76f5cc64d.tar.bz2 | |
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>
Diffstat (limited to 'Doc/library')
| -rw-r--r-- | Doc/library/multiprocessing.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 50b9003..36c6333 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 |