[Python-checkins] cpython (3.4): Issue 22830: Clarify docs for functools.cmp_to_key().

[raymond.hettinger]

https://hg.python.org/cpython/rev/63274cf1b40d
changeset:   93444:63274cf1b40d
branch:      3.4
parent:      93440:9001298e3094
user:        Raymond Hettinger <python at rcn.com>
date:        Sun Nov 09 17:20:56 2014 -0800
summary:
  Issue 22830:  Clarify docs for functools.cmp_to_key().

files:
  Doc/library/functools.rst |  9 +++++----
  1 files changed, 5 insertions(+), 4 deletions(-)


diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -21,8 +21,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 from Python 2 which supported the use of
@@ -31,13 +31,14 @@
    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 indicating 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 :ref:`sortinghowto`.
+
    .. versionadded:: 3.2
 
 

-- 
Repository URL: https://hg.python.org/cpython