From 4fb329d3eecdaf8929f1dbf494b05a2045fc053b Mon Sep 17 00:00:00 2001 From: Wolfgang Maier Date: Mon, 15 Oct 2018 21:06:53 +0200 Subject: [PATCH] fix dangling keyfunc examples in documentation of heapq and sorted (GH-1432) * fix dangling mention of key=str.lower in heapq doc * Fix dangling mention of keyfunc example for sorted() (cherry picked from commit 6bdb6f7675922e601e742758c7c240a751fd365b) Co-authored-by: Wolfgang Maier --- Doc/library/functions.rst | 4 ++-- Doc/library/heapq.rst | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index b6e52469bd85b5..bc528dd1711def 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -1383,8 +1383,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. diff --git a/Doc/library/heapq.rst b/Doc/library/heapq.rst index 7e33e7481467fa..d04033b1ffa0d0 100644 --- a/Doc/library/heapq.rst +++ b/Doc/library/heapq.rst @@ -110,17 +110,17 @@ The module also offers three general purpose functions based on heaps. Return a list with the *n* largest elements from the dataset defined by *iterable*. *key*, if provided, specifies a function of one argument that is - used to extract a comparison key from each element in the iterable: - ``key=str.lower`` Equivalent to: ``sorted(iterable, key=key, - reverse=True)[:n]`` + used to extract a comparison key from each element in *iterable* (for example, + ``key=str.lower``). Equivalent to: ``sorted(iterable, key=key, + reverse=True)[:n]``. .. function:: nsmallest(n, iterable, key=None) Return a list with the *n* smallest elements from the dataset defined by *iterable*. *key*, if provided, specifies a function of one argument that is - used to extract a comparison key from each element in the iterable: - ``key=str.lower`` Equivalent to: ``sorted(iterable, key=key)[:n]`` + used to extract a comparison key from each element in *iterable* (for example, + ``key=str.lower``). Equivalent to: ``sorted(iterable, key=key)[:n]``. The latter two functions perform best for smaller values of *n*. For larger