Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-101777: minor clarification in PriorityQueue docs #102026

Merged
merged 2 commits into from
Feb 21, 2023
Merged

gh-101777: minor clarification in PriorityQueue docs #102026

merged 2 commits into from
Feb 21, 2023

Conversation

OTheDev
Copy link
Contributor

@OTheDev OTheDev commented Feb 18, 2023 •
edited by bedevere-bot
Loading

@OTheDev OTheDev requested a review from rhettinger as a code owner February 18, 2023 13:33
@bedevere-bot bedevere-bot mentioned this pull request Feb 18, 2023
Closed
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Feb 18, 2023
@hauntsaninja hauntsaninja added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Feb 19, 2023
@lucasalavapena
Copy link

Why not update sorted(list(entries))[0] to min(entries) like pochmann suggested in #101777 ? Might as well do it in this PR, since it is a small change

@OTheDev
Copy link
Contributor Author

OTheDev commented Feb 20, 2023

@lucasalavapena Sure, I'd be happy to change sorted(list(entries))[0] to min(entries) 👍

Hope that's okay with you too @rhettinger @hauntsaninja @Eclips4!

@cpython-cla-bot
Copy link

cpython-cla-bot bot commented Feb 20, 2023 •
edited
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@erlend-aasland erlend-aasland merged commit 350ba7c into python:main Feb 21, 2023
@miss-islington
Copy link
Contributor

Thanks @OTheDev for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 21, 2023
@OTheDev @miss-islington
pythongh-101777: Make PriorityQueue docs slightly clearer (pythonGH…
2f10723 
…-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 <116417456+OTheDev@users.noreply.github.com>
@bedevere-bot
Copy link

GH-102106 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Feb 21, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 21, 2023
@OTheDev @miss-islington
pythongh-101777: Make PriorityQueue docs slightly clearer (pythonGH…
c30d39c 
…-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 <116417456+OTheDev@users.noreply.github.com>
@bedevere-bot
Copy link

GH-102107 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Feb 21, 2023
miss-islington added a commit that referenced this pull request Feb 21, 2023
@miss-islington @OTheDev
gh-101777: Make PriorityQueue docs slightly clearer (GH-102026)
2d9f8d4 
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 <116417456+OTheDev@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Feb 21, 2023
@miss-islington @OTheDev
gh-101777: Make PriorityQueue docs slightly clearer (GH-102026)
f94ffcf 
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 <116417456+OTheDev@users.noreply.github.com>
ericvsmith
ericvsmith reviewed Feb 22, 2023
View reviewed changes
Doc/library/queue.rst
@@ -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
Copy link
Member

@ericvsmith ericvsmith Feb 22, 2023 •
edited by AlexWaygood
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ericvsmith Sorry to break the consistency in the file. Would you like me to open a PR?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@OTheDev : yes, go ahead and open a PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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? :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PEP 8 mentions this for comments.

See python/peps#3024.

@OTheDev OTheDev mentioned this pull request Feb 22, 2023
Merged
@erlend-aasland erlend-aasland mentioned this pull request Feb 22, 2023
Closed
carljm added a commit to carljm/cpython that referenced this pull request Feb 23, 2023
@carljm
Merge branch 'main' into lockfreecp
b257a16 
* 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)
  ...
python-sidebar pushed a commit to python-sidebar/Python-Documentation-Fork-With-TOC that referenced this pull request Sep 1, 2024
@OTheDev @python-sidebar
pythongh-101777: Make PriorityQueue docs slightly clearer (python#1…
2b46656 
…02026)

Adjust wording slightly, and use min(entries) instead of
sorted(list(entries))[0] as an example.
python-sidebar pushed a commit to python-sidebar/Python-Documentation-Fork-With-TOC that referenced this pull request Sep 1, 2024
@OTheDev @python-sidebar
pythongh-101777: Make PriorityQueue docs slightly clearer (python#1…
cb150e2 
…02026)

Adjust wording slightly, and use min(entries) instead of
sorted(list(entries))[0] as an example.
JelleZijlstra pushed a commit to JelleZijlstra/cpython that referenced this pull request Sep 10, 2024
@OTheDev @JelleZijlstra
pythongh-101777: Make PriorityQueue docs slightly clearer (python#1…
f3816fb 
…02026)

Adjust wording slightly, and use min(entries) instead of
sorted(list(entries))[0] as an example.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erlend-aasland erlend-aasland erlend-aasland left review comments

@ericvsmith ericvsmith ericvsmith left review comments

@Eclips4 Eclips4 Eclips4 approved these changes

@hauntsaninja hauntsaninja hauntsaninja approved these changes

@rhettinger rhettinger rhettinger approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Weird PriorityQueue description
9 participants
@OTheDev @lucasalavapena @miss-islington @bedevere-bot @ericvsmith @rhettinger @hauntsaninja @erlend-aasland @Eclips4