[3.12] Align functools.reduce() docstring with PEP-257 (GH-126045) (#126114)

Yak-shave in preparation for Argument Clinic adaption in gh-125999.

(cherry picked from commit 9b14083497f50213f908c1359eeaf47c97161347)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

diff --git a/Lib/functools.py b/Lib/functools.py
index 318efd04fd81db0bca7eca6c7c35c77582489823..f6849899e7578e9a3fd1c1bbdcee2afeb22c021e 100644 (file)
--- a/Lib/functools.py
+++ b/Lib/functools.py
@@ -238,12 +238,14 @@ def reduce(function, sequence, initial=_initial_missing):
     """
     reduce(function, iterable[, initial]) -> value
 
-    Apply a function of two arguments cumulatively to the items of a sequence
-    or iterable, from left to right, so as to reduce the iterable to a single
-    value.  For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates
-    ((((1+2)+3)+4)+5).  If initial is present, it is placed before the items
-    of the iterable in the calculation, and serves as a default when the
-    iterable is empty.
+    Apply a function of two arguments cumulatively to the items of an iterable, from left to right.
+
+    This effectively reduces the iterable to a single value.  If initial is present,
+    it is placed before the items of the iterable in the calculation, and serves as
+    a default when the iterable is empty.
+
+    For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])
+    calculates ((((1 + 2) + 3) + 4) + 5).
     """
 
     it = iter(sequence)

diff --git a/Modules/_functoolsmodule.c b/Modules/_functoolsmodule.c
index a8001d71223fdc912969638d6b34af2a9ba4bb41..a6d1b83984bcfa5cc4e3c63ea1fbb3ddbea2901e 100644 (file)
--- a/Modules/_functoolsmodule.c
+++ b/Modules/_functoolsmodule.c
@@ -734,12 +734,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 **********************************************************/