]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-27873: Update docstring for multiprocessing.Pool.map (GH-17436)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 3 Dec 2019 23:36:47 +0000 (15:36 -0800)
committerGitHub <noreply@github.com>
Tue, 3 Dec 2019 23:36:47 +0000 (15:36 -0800)
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>
Doc/library/multiprocessing.rst

index 96e0dc831b79564aa343a2c069c117b968e7bd3b..9bed380117edd060a1690696583af7501afdad62 100644 (file)
@@ -2142,7 +2142,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