diff options
| author | Raymond Hettinger <python@rcn.com> | 2010-09-14 23:13:42 (GMT) |
|---|---|---|
| committer | Raymond Hettinger <python@rcn.com> | 2010-09-14 23:13:42 (GMT) |
| commit | 476a31ef1e188d30a04629616b30e89758850303 (patch) | |
| tree | fb978bcf7560a3eb9bc86e5ccc743d918bfcd810 | |
| parent | 1006bd459bc1cdd2aeb1762fadc6cc64d62c819f (diff) | |
| download | cpython-476a31ef1e188d30a04629616b30e89758850303.zip cpython-476a31ef1e188d30a04629616b30e89758850303.tar.gz cpython-476a31ef1e188d30a04629616b30e89758850303.tar.bz2 | |
Issue 9802: Document min()/max() sort stability
| -rw-r--r-- | Doc/library/functions.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 46f419e..4f1c91c 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -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]) |