summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2024-01-17 01:38:06 (GMT)
committerGitHub <noreply@github.com>2024-01-17 01:38:06 (GMT)
commit644b4a1e87b08fb8e67a81cbe474d9c5178ae77c (patch)
treea8f8981d5c50d8aafa240caf04ee915389f9a3bf
parentb21dd364958c7b29893841cf8ec28f33d691cb9a (diff)
downloadcpython-644b4a1e87b08fb8e67a81cbe474d9c5178ae77c.zip
cpython-644b4a1e87b08fb8e67a81cbe474d9c5178ae77c.tar.gz
cpython-644b4a1e87b08fb8e67a81cbe474d9c5178ae77c.tar.bz2
[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 8d26db45df479a54eccd2aced7d8a5ea9fd0ffa5) Co-authored-by: Erlend E. Aasland <erlend@python.org>
-rw-r--r--Doc/library/concurrent.futures.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/concurrent.futures.rst b/Doc/library/concurrent.futures.rst
index 8ab2c3a..426ff2b 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*