summaryrefslogtreecommitdiffstats
path: root/Doc/library/functions.rst
diff options
context:
space:
mode:
authorWolfgang Maier <wolfgang.maier@biologie.uni-freiburg.de>2018-10-15 19:06:53 (GMT)
committerBrian Curtin <brian@python.org>2018-10-15 19:06:53 (GMT)
commit6bdb6f7675922e601e742758c7c240a751fd365b (patch)
tree2db52433eee8ae3408179a41dc78749a7931b5b2 /Doc/library/functions.rst
parent18fb1fb943b7dbd7f8a76017ee2a67ef13effb85 (diff)
downloadcpython-6bdb6f7675922e601e742758c7c240a751fd365b.zip
cpython-6bdb6f7675922e601e742758c7c240a751fd365b.tar.gz
cpython-6bdb6f7675922e601e742758c7c240a751fd365b.tar.bz2
fix dangling keyfunc examples in documentation of heapq and sorted (#1432)
* fix dangling mention of key=str.lower in heapq doc * Fix dangling mention of keyfunc example for sorted()
Diffstat (limited to 'Doc/library/functions.rst')
-rw-r--r--Doc/library/functions.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 17960eb..e7b98eb 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1412,8 +1412,8 @@ are always available. They are listed here in alphabetical order.
Has two optional arguments which must be specified as keyword arguments.
*key* specifies a function of one argument that is used to extract a comparison
- key from each list element: ``key=str.lower``. The default value is ``None``
- (compare the elements directly).
+ key from each element in *iterable* (for example, ``key=str.lower``). The
+ default value is ``None`` (compare the elements directly).
*reverse* is a boolean value. If set to ``True``, then the list elements are
sorted as if each comparison were reversed.