Skip to content

Commit

Permalink
bpo-27873: Update docstring for multiprocessing.Pool.map (pythonGH-17436
Browse files Browse the repository at this point in the history
)

Update docstring for `multiprocessing.Pool.map` to mention `pool.starmap()`.

Prev PR: python#17367  @aeros


https://bugs.python.org/issue27873
  • Loading branch information
aisk authored and miss-islington committed Dec 3, 2019
1 parent 8943318 commit eb48a45
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion Doc/library/multiprocessing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit eb48a45

Please sign in to comment.