diff options
| author | Sergey B Kirpichev <skirpichev@gmail.com> | 2024-10-29 08:08:08 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-29 08:08:08 (GMT) |
| commit | 9b14083497f50213f908c1359eeaf47c97161347 (patch) | |
| tree | c01bd1de364f4123235d5c2bae28cdb99cebfa8e /Modules | |
| parent | aeafaf4cda5bfce44bb054b4c530696901646abe (diff) | |
| download | cpython-9b14083497f50213f908c1359eeaf47c97161347.zip cpython-9b14083497f50213f908c1359eeaf47c97161347.tar.gz cpython-9b14083497f50213f908c1359eeaf47c97161347.tar.bz2 | |
Align functools.reduce() docstring with PEP-257 (#126045)
Yak-shave in preparation for Argument Clinic adaption in gh-125999.
Diffstat (limited to 'Modules')
| -rw-r--r-- | Modules/_functoolsmodule.c | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/Modules/_functoolsmodule.c b/Modules/_functoolsmodule.c index 802b1cf..da4e088 100644 --- a/Modules/_functoolsmodule.c +++ b/Modules/_functoolsmodule.c @@ -1009,12 +1009,14 @@ Fail: PyDoc_STRVAR(functools_reduce_doc, "reduce(function, iterable[, initial], /) -> value\n\ \n\ -Apply a function of two arguments cumulatively to the items of a sequence\n\ -or iterable, from left to right, so as to reduce the iterable to a single\n\ -value. For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates\n\ -((((1+2)+3)+4)+5). If initial is present, it is placed before the items\n\ -of the iterable in the calculation, and serves as a default when the\n\ -iterable is empty."); +Apply a function of two arguments cumulatively to the items of an iterable, from left to right.\n\ +\n\ +This effectively reduces the iterable to a single value. If initial is present,\n\ +it is placed before the items of the iterable in the calculation, and serves as\n\ +a default when the iterable is empty.\n\ +\n\ +For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])\n\ +calculates ((((1 + 2) + 3) + 4) + 5)."); /* lru_cache object **********************************************************/ |