[Python-checkins] bpo-27873: Update docstring for multiprocessing.Pool.map (GH-17436)

Miss Islington (bot) webhook-mailer at python.org
Tue Dec 3 18:37:44 EST 2019


https://github.com/python/cpython/commit/baf07395eaa77e515ddfa1d3f42785d50b4d2889
commit: baf07395eaa77e515ddfa1d3f42785d50b4d2889
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-12-03T15:37:40-08:00
summary:

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 at users.noreply.github.com>

files:
M Doc/library/multiprocessing.rst

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index d8182feab963a..3c7b5cc126209 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



More information about the Python-checkins mailing list