diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-12-03 23:37:40 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-12-03 23:37:40 (GMT) |
commit | baf07395eaa77e515ddfa1d3f42785d50b4d2889 (patch) | |
tree | cd4b6d2664feae2c8e10ec92e7ece2c57df684ff /Doc/library | |
parent | 8859fc629474ab1ca7eb2e67aec538097c327e58 (diff) | |
download | cpython-baf07395eaa77e515ddfa1d3f42785d50b4d2889.zip cpython-baf07395eaa77e515ddfa1d3f42785d50b4d2889.tar.gz cpython-baf07395eaa77e515ddfa1d3f42785d50b4d2889.tar.bz2 |
bpo-27873: Update docstring for multiprocessing.Pool.map (GH-17436)
Update docstring for `multiprocessing.Pool.map` to mention `pool.starmap()`.
Prev PR: https://github.com/python/cpython/pull/17367 @aeros
https://bugs.python.org/issue27873
(cherry picked from commit eb48a451e3844185b9a8751c9badffbddc89689d)
Co-authored-by: An Long <aisk@users.noreply.github.com>
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/multiprocessing.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index d8182fe..3c7b5cc 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -2169,7 +2169,8 @@ with the :class:`Pool` class. .. method:: map(func, iterable[, chunksize]) A parallel equivalent of the :func:`map` built-in function (it supports only - one *iterable* argument though). It blocks until the result is ready. + one *iterable* argument though, for multiple iterables see :meth:`starmap`). + It blocks until the result is ready. This method chops the iterable into a number of chunks which it submits to the process pool as separate tasks. The (approximate) size of these |