From: Erlend E. Aasland <erlend@python.org>
Date: Wed, 17 Jan 2024 01:31:16 +0000 (+0100)
Subject: gh-112043: Align concurrent.futures.Executor.map docs with implementation (#114153)
X-Git-Tag: v3.13.0a3~4
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8d26db45df479a54eccd2aced7d8a5ea9fd0ffa5;p=thirdparty%2FPython%2Fcpython.git

gh-112043: Align concurrent.futures.Executor.map docs with implementation (#114153)

The first parameter is named 'fn', not 'func'.
---

diff --git a/Doc/library/concurrent.futures.rst b/Doc/library/concurrent.futures.rst
index deefb8606ead..760e1196d7cf 100644
--- a/Doc/library/concurrent.futures.rst
+++ b/Doc/library/concurrent.futures.rst
@@ -39,14 +39,14 @@ Executor Objects
              future = executor.submit(pow, 323, 1235)
              print(future.result())
 
-   .. method:: map(func, *iterables, timeout=None, chunksize=1)
+   .. method:: map(fn, *iterables, timeout=None, chunksize=1)
 
-      Similar to :func:`map(func, *iterables) <map>` except:
+      Similar to :func:`map(fn, *iterables) <map>` except:
 
       * the *iterables* are collected immediately rather than lazily;
 
-      * *func* is executed asynchronously and several calls to
-        *func* may be made concurrently.
+      * *fn* is executed asynchronously and several calls to
+        *fn* may be made concurrently.
 
       The returned iterator raises a :exc:`TimeoutError`
       if :meth:`~iterator.__next__` is called and the result isn't available
@@ -54,7 +54,7 @@ Executor Objects
       *timeout* can be an int or a float.  If *timeout* is not specified or
       ``None``, there is no limit to the wait time.
 
-      If a *func* call raises an exception, then that exception will be
+      If a *fn* call raises an exception, then that exception will be
       raised when its value is retrieved from the iterator.
 
       When using :class:`ProcessPoolExecutor`, this method chops *iterables*