gh-133530: Improve heapq documenation #133531
Open
+14
−38
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Removes a lot of unnecessary (and personal) parts. Also differentiate between heaps more, reference max-heap instead of a reverse list, and replace binary tree with a graphic I generated.
Some other thoughts:
Currently we use a pretty long sports analogy and use gender references, maybe a more neutral and technical description instead?
Add some headers for min/max heaps in the introduction for easier reference?
heapqdocumentation #133530📚 Documentation preview 📚: https://cpython-previews--133531.org.readthedocs.build/en/133531/library/heapq.html