]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Issue 9802: Document min()/max() sort stability
authorRaymond Hettinger <python@rcn.com>
Tue, 14 Sep 2010 23:13:42 +0000 (23:13 +0000)
committerRaymond Hettinger <python@rcn.com>
Tue, 14 Sep 2010 23:13:42 +0000 (23:13 +0000)
Doc/library/functions.rst

index 46f419e1c4a7bd05b67cb2cf9bc1b66134886491..4f1c91ca082977858fba97cd59566d2e23b3f08f 100644 (file)
@@ -634,6 +634,10 @@ are always available.  They are listed here in alphabetical order.
    The optional keyword-only *key* argument specifies a one-argument ordering
    function like that used for :meth:`list.sort`.
 
+   If multiple items are maximal, the function returns the first one encountered.
+   This is consistent with other sort-stability preserving tools such as
+   ``sorted(iterable, key=keyfunc, reverse=True)[0]` and
+   ``heapq.nlargest(1, iterable, key=keyfunc)``.
 
 .. function:: memoryview(obj)
    :noindex:
@@ -651,6 +655,10 @@ are always available.  They are listed here in alphabetical order.
    The optional keyword-only *key* argument specifies a one-argument ordering
    function like that used for :meth:`list.sort`.
 
+   If multiple items are minimal, the function returns the first one encountered.
+   This is consistent with other sort-stability preserving tools such as
+   ``sorted(iterable, key=keyfunc)[0]` and
+   ``heapq.nsmallest(1, iterable, key=keyfunc)``.
 
 .. function:: next(iterator[, default])