fix dangling keyfunc examples in documentation of heapq and sorted #1432

wm75 · 2017-05-03T14:46:28Z

used the same wording as in the description of list.sort

mention-bot · 2017-05-03T14:46:30Z

@wm75, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @rhettinger and @benjaminp to be potential reviewers.

serhiy-storchaka · 2017-05-03T17:30:02Z

Doc/library/heapq.rst

-   used to extract a comparison key from each element in the iterable:
-   ``key=str.lower`` Equivalent to:  ``sorted(iterable, key=key,
+   used to extract a comparison key from each element in the iterable (for example,
+   ``key=str.lower``).  Equivalent to:  ``sorted(iterable, key=key,
   reverse=True)[:n]``


Isn't a period missed?

You mean at the very end. Not sure about this because that last part is not a complete sentence, but then I'm not a native speaker 🤷‍♂️

FWIW, I would probably use a full stop at the end (and again for nsmallest). The last part still functions as a sentence, it comes after other sentences (now) using full stops, and another full stop would identify the end of the paragraph.

If the code was written on a separate line, I probably wouldn’t use a full stop.

Sounds convincing, plus the docs have many other examples of incomplete sentences like this that all have a period.

wm75 · 2018-04-07T22:38:29Z

Jut realized that the documentation for sorted() has the identical problem. Fixed it there, too.

briancurtin · 2018-09-29T16:38:35Z

Doc/library/heapq.rst

-   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 the iterable (for example,


I think it would be more clear for this and the following reference to be *iterable* like you did in the Doc/library/functions.rst part of this change.

agreed and fixed.

bedevere-bot · 2018-09-29T16:38:48Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

wm75 · 2018-10-15T11:39:57Z

I have made the requested changes; please review again

bedevere-bot · 2018-10-15T11:39:59Z

Thanks for making the requested changes!

@briancurtin: please review the changes made to this pull request.

bedevere-bot · 2018-10-15T19:06:56Z

@briancurtin: Please replace # with GH- in the commit message next time. Thanks!

miss-islington · 2018-10-15T19:06:56Z

Thanks @wm75 for the PR, and @briancurtin for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖

…ythonGH-1432) * fix dangling mention of key=str.lower in heapq doc * Fix dangling mention of keyfunc example for sorted() (cherry picked from commit 6bdb6f7) Co-authored-by: Wolfgang Maier <wolfgang.maier@biologie.uni-freiburg.de>

bedevere-bot · 2018-10-15T19:07:11Z

GH-9893 is a backport of this pull request to the 3.7 branch.

…ythonGH-1432) * fix dangling mention of key=str.lower in heapq doc * Fix dangling mention of keyfunc example for sorted() (cherry picked from commit 6bdb6f7) Co-authored-by: Wolfgang Maier <wolfgang.maier@biologie.uni-freiburg.de>

bedevere-bot · 2018-10-15T19:07:21Z

GH-9894 is a backport of this pull request to the 3.6 branch.

…H-1432) * fix dangling mention of key=str.lower in heapq doc * Fix dangling mention of keyfunc example for sorted() (cherry picked from commit 6bdb6f7) Co-authored-by: Wolfgang Maier <wolfgang.maier@biologie.uni-freiburg.de>

…orted (#1432)" This reverts commit 6bdb6f7.

* master: (621 commits) Update opcode.h header comment to mention the source data file (pythonGH-9935) bpo-34936: Fix TclError in tkinter.Spinbox.selection_element(). (pythonGH-9760) Updated documentation on logging.debug(). (pythonGH-9946) bpo-34765: Update the install-sh file (pythonGH-9592) bpo-35008: Fix possible leaks in Element.__setstate__(). (pythonGH-9924) bpo-35011: Restore use of pyexpatns.h in libexpat (pythonGH-9939) bpo-24658: Fix read/write greater than 2 GiB on macOS (pythonGH-1705) Add missing comma to wsgiref doc (pythonGH-9932) bpo-23420: Verify the value of '-s' when execute the CLI of cProfile (pythonGH-9925) Doc: Fix is_prime (pythonGH-9909) In email docs, correct spelling of foregoing (python#9856) In email.parser in message_from_bytes, update `strict` to `policy` (python#9854) bpo-34997: Fix test_logging.ConfigDictTest.test_out_of_order (pythonGH-9913) Added CLI starter example to logging cookbook. (pythonGH-9910) bpo-34783: Fix test_nonexisting_script() (pythonGH-9896) bpo-23554: Change echo server example class name from EchoServerClientProtocol to EchoServerProtocol (pythonGH-9859) bpo-34989: python-gdb.py: fix current_line_num() (pythonGH-9889) Stop using deprecated logging API in Sphinx suspicious checker (pythonGH-9875) fix dangling keyfunc examples in documentation of heapq and sorted (python#1432) bpo-34844: logging.Formatter enhancement - Ensure style and format string matches in logging.Formatter (pythonGH-9703) ...

* master: (1787 commits) Update opcode.h header comment to mention the source data file (pythonGH-9935) bpo-34936: Fix TclError in tkinter.Spinbox.selection_element(). (pythonGH-9760) Updated documentation on logging.debug(). (pythonGH-9946) bpo-34765: Update the install-sh file (pythonGH-9592) bpo-35008: Fix possible leaks in Element.__setstate__(). (pythonGH-9924) bpo-35011: Restore use of pyexpatns.h in libexpat (pythonGH-9939) bpo-24658: Fix read/write greater than 2 GiB on macOS (pythonGH-1705) Add missing comma to wsgiref doc (pythonGH-9932) bpo-23420: Verify the value of '-s' when execute the CLI of cProfile (pythonGH-9925) Doc: Fix is_prime (pythonGH-9909) In email docs, correct spelling of foregoing (python#9856) In email.parser in message_from_bytes, update `strict` to `policy` (python#9854) bpo-34997: Fix test_logging.ConfigDictTest.test_out_of_order (pythonGH-9913) Added CLI starter example to logging cookbook. (pythonGH-9910) bpo-34783: Fix test_nonexisting_script() (pythonGH-9896) bpo-23554: Change echo server example class name from EchoServerClientProtocol to EchoServerProtocol (pythonGH-9859) bpo-34989: python-gdb.py: fix current_line_num() (pythonGH-9889) Stop using deprecated logging API in Sphinx suspicious checker (pythonGH-9875) fix dangling keyfunc examples in documentation of heapq and sorted (python#1432) bpo-34844: logging.Formatter enhancement - Ensure style and format string matches in logging.Formatter (pythonGH-9703) ...

fix dangling mention of key=str.lower in heapq doc

548de73

the-knights-who-say-ni added the CLA signed label May 3, 2017

serhiy-storchaka reviewed May 3, 2017

View reviewed changes

serhiy-storchaka requested a review from rhettinger May 3, 2017 17:32

serhiy-storchaka assigned rhettinger May 3, 2017

serhiy-storchaka added docs Documentation in the Doc dir trivial labels May 3, 2017

brettcannon added skip issue and removed trivial labels Jul 14, 2017

brettcannon added the awaiting review label Feb 2, 2018

Fix dangling mention of keyfunc example for sorted()

2f20151

wm75 changed the title ~~fix dangling mention of key=str.lower in heapq doc~~ fix dangling keyfunc examples in documentation of heapq and sorted Apr 7, 2018

serhiy-storchaka added needs backport to 3.6 skip news labels Apr 8, 2018

Add missing periods

96a214e

matrixise approved these changes May 14, 2018

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels May 14, 2018

briancurtin requested changes Sep 29, 2018

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting core review labels Sep 29, 2018

Italicize references to function params

7dd25ba

bedevere-bot removed the awaiting changes label Oct 15, 2018

bedevere-bot added the awaiting change review label Oct 15, 2018

briancurtin approved these changes Oct 15, 2018

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting change review labels Oct 15, 2018

briancurtin merged commit 6bdb6f7 into python:master Oct 15, 2018

bedevere-bot removed the awaiting merge label Oct 15, 2018

bedevere-bot removed the needs backport to 3.7 label Oct 15, 2018

bedevere-bot removed the needs backport to 3.6 label Oct 15, 2018

vstinner added a commit that referenced this pull request Oct 16, 2018

Revert "fix dangling keyfunc examples in documentation of heapq and s…

b63845b

…orted (#1432)" This reverts commit 6bdb6f7.

wm75 deleted the wm75-heapq-doc-patch branch July 20, 2022 18:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix dangling keyfunc examples in documentation of heapq and sorted #1432

fix dangling keyfunc examples in documentation of heapq and sorted #1432

wm75 commented May 3, 2017

mention-bot commented May 3, 2017

serhiy-storchaka May 3, 2017

wm75 Apr 7, 2018

vadmium Apr 8, 2018

wm75 Apr 9, 2018

wm75 commented Apr 7, 2018

briancurtin Sep 29, 2018

wm75 Oct 15, 2018

bedevere-bot commented Sep 29, 2018

wm75 commented Oct 15, 2018

bedevere-bot commented Oct 15, 2018

bedevere-bot commented Oct 15, 2018

miss-islington commented Oct 15, 2018

bedevere-bot commented Oct 15, 2018

bedevere-bot commented Oct 15, 2018

fix dangling keyfunc examples in documentation of heapq and sorted #1432

fix dangling keyfunc examples in documentation of heapq and sorted #1432

Conversation

wm75 commented May 3, 2017

mention-bot commented May 3, 2017

serhiy-storchaka May 3, 2017

Choose a reason for hiding this comment

wm75 Apr 7, 2018

Choose a reason for hiding this comment

vadmium Apr 8, 2018

Choose a reason for hiding this comment

wm75 Apr 9, 2018

Choose a reason for hiding this comment

wm75 commented Apr 7, 2018

briancurtin Sep 29, 2018

Choose a reason for hiding this comment

wm75 Oct 15, 2018

Choose a reason for hiding this comment

bedevere-bot commented Sep 29, 2018

wm75 commented Oct 15, 2018

bedevere-bot commented Oct 15, 2018

bedevere-bot commented Oct 15, 2018

miss-islington commented Oct 15, 2018

bedevere-bot commented Oct 15, 2018

bedevere-bot commented Oct 15, 2018