diff options
author | Raymond Hettinger <python@rcn.com> | 2013-06-25 05:43:02 (GMT) |
---|---|---|
committer | Raymond Hettinger <python@rcn.com> | 2013-06-25 05:43:02 (GMT) |
commit | 4d6018fe4508ed8520d22edc14c54dc9a1782c9f (patch) | |
tree | b614f993b9b7b8cba22a4009cf63a469c443a504 /Doc | |
parent | d7a034bd7553719e554beea1746079ba72333015 (diff) | |
download | cpython-4d6018fe4508ed8520d22edc14c54dc9a1782c9f.zip cpython-4d6018fe4508ed8520d22edc14c54dc9a1782c9f.tar.gz cpython-4d6018fe4508ed8520d22edc14c54dc9a1782c9f.tar.bz2 |
Issue 18111: Add a default argument to min() and max()
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/functions.rst | 34 |
1 files changed, 20 insertions, 14 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 43164af..3d239ec 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -753,19 +753,22 @@ are always available. They are listed here in alphabetical order. already arranged into argument tuples, see :func:`itertools.starmap`\. -.. function:: max(iterable, *[, key]) +.. function:: max(iterable, *[, default, key]) max(arg1, arg2, *args[, key]) Return the largest item in an iterable or the largest of two or more arguments. - If one positional argument is provided, *iterable* must be a non-empty - iterable (such as a non-empty string, tuple or list). The largest item - in the iterable is returned. If two or more positional arguments are - provided, the largest of the positional arguments is returned. + If one positional argument is provided, it should be an :term:`iterable`. + The largest item in the iterable is returned. If two or more positional + arguments are provided, the smallest of the positional arguments is + returned. - The optional keyword-only *key* argument specifies a one-argument ordering - function like that used for :meth:`list.sort`. + There are two optional keyword-only arguments. The *key* argument specifies + a one-argument ordering function like that used for :meth:`list.sort`. The + *default* argument specifies an object to return if the provided iterable is + empty. If the iterable is empty and *default* is not provided, a + :exc:`ValueError` is raised. If multiple items are maximal, the function returns the first one encountered. This is consistent with other sort-stability preserving tools @@ -781,19 +784,22 @@ are always available. They are listed here in alphabetical order. :ref:`typememoryview` for more information. -.. function:: min(iterable, *[, key]) +.. function:: min(iterable, *[, default, key]) min(arg1, arg2, *args[, key]) Return the smallest item in an iterable or the smallest of two or more arguments. - If one positional argument is provided, *iterable* must be a non-empty - iterable (such as a non-empty string, tuple or list). The smallest item - in the iterable is returned. If two or more positional arguments are - provided, the smallest of the positional arguments is returned. + If one positional argument is provided, it should be an :term:`iterable`. + The smallest item in the iterable is returned. If two or more positional + arguments are provided, the smallest of the positional arguments is + returned. - The optional keyword-only *key* argument specifies a one-argument ordering - function like that used for :meth:`list.sort`. + There are two optional keyword-only arguments. The *key* argument specifies + a one-argument ordering function like that used for :meth:`list.sort`. The + *default* argument specifies an object to return if the provided iterable is + empty. If the iterable is empty and *default* is not provided, a + :exc:`ValueError` is raised. If multiple items are minimal, the function returns the first one encountered. This is consistent with other sort-stability preserving tools |