gh-101777: minor clarification in PriorityQueue docs
#102026
Conversation
hauntsaninja
added
needs backport to 3.10
|
Why not update |
|
@lucasalavapena Sure, I'd be happy to change Hope that's okay with you too @rhettinger @hauntsaninja @Eclips4! |
|
All commit authors signed the Contributor License Agreement. |
|
Thanks @OTheDev for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11. |
…-102026) Adjust wording slightly, and use min(entries) instead of sorted(list(entries))[0] as an example. (cherry picked from commit 350ba7c) Co-authored-by: Owain Davies <[email protected]>
|
GH-102106 is a backport of this pull request to the 3.11 branch. |
…-102026) Adjust wording slightly, and use min(entries) instead of sorted(list(entries))[0] as an example. (cherry picked from commit 350ba7c) Co-authored-by: Owain Davies <[email protected]>
|
GH-102107 is a backport of this pull request to the 3.10 branch. |
Adjust wording slightly, and use min(entries) instead of sorted(list(entries))[0] as an example. (cherry picked from commit 350ba7c) Co-authored-by: Owain Davies <[email protected]>
Adjust wording slightly, and use min(entries) instead of sorted(list(entries))[0] as an example. (cherry picked from commit 350ba7c) Co-authored-by: Owain Davies <[email protected]>
| @@ -57,8 +57,8 @@ The :mod:`queue` module defines the following classes and exceptions: | |||
| *maxsize* is less than or equal to zero, the queue size is infinite. | |||
|
|
|||
| The lowest valued entries are retrieved first (the lowest valued entry is the | |||
| one returned by ``sorted(list(entries))[0]``). A typical pattern for entries | |||
There was a problem hiding this comment.
The two spaces after the period here are deliberate. Note that elsewhere in this file, periods have two spaces after them. This is used by some editors (including emacs) when a paragraph is re-flowed. I suggest putting this "extra" space back.
PEP 8 mentions this for comments. https://devguide.python.org/documentation/style-guide/ says one or two spaces is acceptable, but in this case I think we should match the rest of the file.
There was a problem hiding this comment.
@ericvsmith Sorry to break the consistency in the file. Would you like me to open a PR?
There was a problem hiding this comment.
@OTheDev : yes, go ahead and open a PR.
There was a problem hiding this comment.
@ericvsmith There are other instances where there's only one space instead of two after a period in the file. Should I correct those too? :)
There was a problem hiding this comment.
I beg to differ, @ericvsmith. We do not need to encourage contributors to "fix" one or two spaces after period. There's better use of both contributor time and review time. Also, what has PEP-8 with .rst files to do? AFAICS, nothing.
There was a problem hiding this comment.
PEP 8 mentions this for comments.
See python/peps#3024.
* main: (76 commits) Fix syntax error in struct doc example (python#102160) pythongh-99108: Import MD5 and SHA1 from HACL* (python#102089) pythonGH-101777: `queue.rst`: use 2 spaces after a period to be consistent. (python#102143) Few coverage nitpicks for the cmath module (python#102067) pythonGH-100982: Restrict `FOR_ITER_RANGE` to a single instruction to allow instrumentation. (pythonGH-101985) pythongh-102135: Update turtle docs to rename wikipedia demo to rosette (python#102137) pythongh-99942: python.pc on android/cygwin should link to libpython per configure.ac (pythonGH-100356) pythongh-95672 fix typo SkitTest to SkipTest (pythongh-102119) pythongh-101936: Update the default value of fp from io.StringIO to io.BytesIO (pythongh-102100) pythongh-102008: simplify test_except_star by using sys.exception() instead of sys.exc_info() (python#102009) pythongh-101903: Remove obsolete undefs for previously removed macros Py_EnterRecursiveCall and Py_LeaveRecursiveCall (python#101923) pythongh-100556: Improve clarity of `or` docs (python#100589) pythongh-101777: Make `PriorityQueue` docs slightly clearer (python#102026) pythongh-101965: Fix usage of Py_EnterRecursiveCall return value in _bisectmodule.c (pythonGH-101966) pythongh-101578: Amend exception docs (python#102057) pythongh-101961 fileinput.hookcompressed should not set the encoding value for the binary mode (pythongh-102068) pythongh-102056: Fix a few bugs in error handling of exception printing code (python#102078) pythongh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (python#102012) pythongh-101566: Sync with zipp 3.14. (pythonGH-102018) pythonGH-99818: improve the documentation for zipfile.Path and Traversable (pythonGH-101589) ...
…02026) Adjust wording slightly, and use min(entries) instead of sorted(list(entries))[0] as an example.
…02026) Adjust wording slightly, and use min(entries) instead of sorted(list(entries))[0] as an example.
…02026) Adjust wording slightly, and use min(entries) instead of sorted(list(entries))[0] as an example.
Tries to fix #101777