Expand docstring with link to wikipedia.

jaraco · Aug 1, 2024 · 860517e · 860517e
1 parent 36a0d73
commit 860517e
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/jaraco/functools/__init__.py b/jaraco/functools/__init__.py
@@ -14,6 +14,14 @@ def compose(*funcs):
     """
     Compose any number of unary functions into a single unary function.
 
+    Comparable to
+    `function composition <https://en.wikipedia.org/wiki/Function_composition>`_
+    in mathematics:
+
+    ``h = g ∘ f`` implies ``h(x) = g(f(x))``.
+
+    In Python, ``h = compose(g, f)``.
+
     >>> import textwrap
     >>> expected = str.strip(textwrap.dedent(compose.__doc__))
     >>> strip_and_dedent = compose(str.strip, textwrap.dedent)