summaryrefslogtreecommitdiffstats
path: root/Python
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2014-05-19 21:20:52 (GMT)
committerRaymond Hettinger <python@rcn.com>2014-05-19 21:20:52 (GMT)
commit2a54582d72e50ae809938122212391157ec773e9 (patch)
tree62bd6e5fa0796af8e326f4b81d45dd9b9adf7858 /Python
parentdebcb9dd542e06fa8e6fe6f1fb8c4549ae9ddeea (diff)
downloadcpython-2a54582d72e50ae809938122212391157ec773e9.zip
cpython-2a54582d72e50ae809938122212391157ec773e9.tar.gz
cpython-2a54582d72e50ae809938122212391157ec773e9.tar.bz2
Issue 20620: Update the min()/max() docs for the new default argument.
Patch provided by Berker Peksag.
Diffstat (limited to 'Python')
-rw-r--r--Python/bltinmodule.c16
1 files changed, 10 insertions, 6 deletions
diff --git a/Python/bltinmodule.c b/Python/bltinmodule.c
index 8d1255e..d351cd0 100644
--- a/Python/bltinmodule.c
+++ b/Python/bltinmodule.c
@@ -1454,10 +1454,12 @@ builtin_min(PyObject *self, PyObject *args, PyObject *kwds)
}
PyDoc_STRVAR(min_doc,
-"min(iterable[, key=func]) -> value\n\
-min(a, b, c, ...[, key=func]) -> value\n\
+"min(iterable, *[, default=obj, key=func]) -> value\n\
+min(arg1, arg2, *args, *[, key=func]) -> value\n\
\n\
-With a single iterable argument, return its smallest item.\n\
+With a single iterable argument, return its smallest item. The\n\
+default keyword-only argument specifies an object to return if\n\
+the provided iterable is empty.\n\
With two or more arguments, return the smallest argument.");
@@ -1468,10 +1470,12 @@ builtin_max(PyObject *self, PyObject *args, PyObject *kwds)
}
PyDoc_STRVAR(max_doc,
-"max(iterable[, key=func]) -> value\n\
-max(a, b, c, ...[, key=func]) -> value\n\
+"max(iterable, *[, default=obj, key=func]) -> value\n\
+max(arg1, arg2, *args, *[, key=func]) -> value\n\
\n\
-With a single iterable argument, return its largest item.\n\
+With a single iterable argument, return its biggest item. The\n\
+default keyword-only argument specifies an object to return if\n\
+the provided iterable is empty.\n\
With two or more arguments, return the largest argument.");