summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/functools.rst33
1 files changed, 16 insertions, 17 deletions
diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 93b2b4a..0c5e57b 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -19,23 +19,22 @@ The :mod:`functools` module defines the following functions:
.. function:: cmp_to_key(func)
- Transform an old-style comparison function to a key-function. Used with
- tools that accept key functions (such as :func:`sorted`, :func:`min`,
- :func:`max`, :func:`heapq.nlargest`, :func:`heapq.nsmallest`,
- :func:`itertools.groupby`).
- This function is primarily used as a transition tool for programs
- being converted to Py3.x where comparison functions are no longer
- supported.
-
- A compare function is any callable that accept two arguments, compares
- them, and returns a negative number for less-than, zero for equality,
- or a positive number for greater-than. A key function is a callable
- that accepts one argument and returns another value that indicates
- the position in the desired collation sequence.
-
- Example::
-
- sorted(iterable, key=cmp_to_key(locale.strcoll)) # locale-aware sort order
+ Transform an old-style comparison function to a key-function. Used with
+ tools that accept key functions (such as :func:`sorted`, :func:`min`,
+ :func:`max`, :func:`heapq.nlargest`, :func:`heapq.nsmallest`,
+ :func:`itertools.groupby`). This function is primarily used as a transition
+ tool for programs being converted to Py3.x where comparison functions are no
+ longer supported.
+
+ A compare function is any callable that accept two arguments, compares them,
+ and returns a negative number for less-than, zero for equality, or a positive
+ number for greater-than. A key function is a callable that accepts one
+ argument and returns another value that indicates the position in the desired
+ collation sequence.
+
+ Example::
+
+ sorted(iterable, key=cmp_to_key(locale.strcoll)) # locale-aware sort order
.. versionadded:: 2.7