Skip to content

Weird PriorityQueue description #101777

Closed
@pochmann

Description

@pochmann

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions