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.

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

Weird PriorityQueue description #101777

Closed
pochmann opened this issue Feb 10, 2023 · 3 comments · Fixed by #102026
Closed

Weird PriorityQueue description #101777

pochmann opened this issue Feb 10, 2023 · 3 comments · Fixed by #102026
Labels
docs Documentation in the Doc dir

Comments

@pochmann
Copy link
Contributor

pochmann commented Feb 10, 2023

Documentation

Someone asked Does PriorityQueue call sorted every time get is called?. First I laughed, how did they come up with that silly idea, but then I saw they got it from the doc and it really does make it sound like that:

The lowest valued entries are retrieved first (the lowest valued entry is the one returned by sorted(list(entries))[0]).

Not only sorted but also list first, and of course even if the queue didn't use a heap, it should be the straightforward min(entries) instead. This is so over-the-top inefficient and complicated that it looks like a weird joke.

Unless there's good reason for it, I suggest to add "as if" and use min:

The lowest valued entries are retrieved first (the lowest valued entry is the one as if returned by min(entries)).

Linked PRs

@pochmann pochmann added the docs Documentation in the Doc dir label Feb 10, 2023
@ericvsmith
Copy link
Member

I'm not sure it needs to be changed, but if it must be, then I'd say something like "the one that would be returned by ...".

@pochmann
Copy link
Contributor Author

Yes, that's better.

@rhettinger
Copy link
Contributor

+1

erlend-aasland pushed a commit that referenced this issue Feb 21, 2023
Adjust wording slightly, and use min(entries) instead of
sorted(list(entries))[0] as an example.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 21, 2023
…-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>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 21, 2023
…-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>
miss-islington added a commit that referenced this issue Feb 21, 2023
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 issue Feb 21, 2023
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 pushed a commit to miss-islington/cpython that referenced this issue Feb 22, 2023
…stent. (pythonGH-102143)

(cherry picked from commit 96bf243)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 22, 2023
…stent. (pythonGH-102143)

(cherry picked from commit 96bf243)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
miss-islington added a commit that referenced this issue Feb 22, 2023
…GH-102143)

(cherry picked from commit 96bf243)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
miss-islington added a commit that referenced this issue Feb 22, 2023
…GH-102143)

(cherry picked from commit 96bf243)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
carljm added a commit to carljm/cpython that referenced this issue Feb 23, 2023
* 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 issue Sep 1, 2024
…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 issue Sep 1, 2024
…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 issue Sep 10, 2024
…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 issue Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants