https://github.com/python/cpython/commit/644b4a1e87b08fb8e67a81cbe474d9c5178ae77c commit: 644b4a1e87b08fb8e67a81cbe474d9c5178ae77c branch: 3.11 author: Miss Islington (bot) <[email protected]> committer: AA-Turner <[email protected]> date: 2024-01-17T01:38:06Z summary:
[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 <[email protected]> files: M Doc/library/concurrent.futures.rst diff --git a/Doc/library/concurrent.futures.rst b/Doc/library/concurrent.futures.rst index 8ab2c3a2be2d65..426ff2bf4ccce0 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* _______________________________________________ Python-checkins mailing list -- [email protected] To unsubscribe send an email to [email protected] https://mail.python.org/mailman3/lists/python-checkins.python.org/ Member address: [email protected]
