diff options
-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 46f419e1c4..4f1c91ca08 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]) |