Issue 22830: Clarify docs for functools.cmp_to_key().
diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 9336f79..086b0b5 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -22,8 +22,8 @@
.. 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`,
+ Transform an old-style comparison function to a :term:`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 Python 3 where comparison functions are
@@ -32,13 +32,16 @@
A comparison 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.
+ argument and returns another value to be used as the sort key.
Example::
sorted(iterable, key=cmp_to_key(locale.strcoll)) # locale-aware sort order
+ For sorting examples and a brief sorting tutorial, see `Sorting HowTo
+ <https://wiki.python.org/moin/HowTo/Sorting/>`_\.
+
+
.. versionadded:: 2.7
.. function:: total_ordering(cls)