Skip to content

Commit 644b4a1

Browse files
[3.11] gh-112043: Align concurrent.futures.Executor.map docs with implementation (GH-114153) (#114165)
The first parameter is named 'fn', not 'func'. (cherry picked from commit 8d26db4) Co-authored-by: Erlend E. Aasland <[email protected]>
1 parent b21dd36 commit 644b4a1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Doc/library/concurrent.futures.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,22 @@ Executor Objects
3939
future = executor.submit(pow, 323, 1235)
4040
print(future.result())
4141

42-
.. method:: map(func, *iterables, timeout=None, chunksize=1)
42+
.. method:: map(fn, *iterables, timeout=None, chunksize=1)
4343

44-
Similar to :func:`map(func, *iterables) <map>` except:
44+
Similar to :func:`map(fn, *iterables) <map>` except:
4545

4646
* the *iterables* are collected immediately rather than lazily;
4747

48-
* *func* is executed asynchronously and several calls to
49-
*func* may be made concurrently.
48+
* *fn* is executed asynchronously and several calls to
49+
*fn* may be made concurrently.
5050

5151
The returned iterator raises a :exc:`TimeoutError`
5252
if :meth:`~iterator.__next__` is called and the result isn't available
5353
after *timeout* seconds from the original call to :meth:`Executor.map`.
5454
*timeout* can be an int or a float. If *timeout* is not specified or
5555
``None``, there is no limit to the wait time.
5656

57-
If a *func* call raises an exception, then that exception will be
57+
If a *fn* call raises an exception, then that exception will be
5858
raised when its value is retrieved from the iterator.
5959

6060
When using :class:`ProcessPoolExecutor`, this method chops *iterables*

0 commit comments

Comments
 (0)