diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2024-01-17 01:37:30 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-17 01:37:30 (GMT) |
commit | 5b08b24f895d69f5b981e61f140fe852303c8c0e (patch) | |
tree | be631ec116e59df9ccc2ce9fecb6cff8f1da3cf6 | |
parent | 12c6424205561f45edbc1041faa8080de2d8def2 (diff) | |
download | cpython-5b08b24f895d69f5b981e61f140fe852303c8c0e.zip cpython-5b08b24f895d69f5b981e61f140fe852303c8c0e.tar.gz cpython-5b08b24f895d69f5b981e61f140fe852303c8c0e.tar.bz2 |
[3.12] gh-112043: Align concurrent.futures.Executor.map docs with implementation (GH-114153) (#114164)
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.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/concurrent.futures.rst b/Doc/library/concurrent.futures.rst index 163f170..cc6df06 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* |