docs: improve Heap top-level documentation#602
Open
Sleywill wants to merge 1 commit intoapple:mainfrom
Open
Conversation
Addresses apple#74: restructures the `Heap` doc comment to explain what the data structure is useful for before diving into implementation details. Adds a "When to use" intro, usage example with optional results, complexity summary with symbol links, and moves implementation details under a header.
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
1 participant
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.
Addresses #74.
What changed
Restructures the
Heapdoc comment to be useful to a wider audience before going into implementation details, as suggested in the issue.Before: The comment opened directly with "A container type implementing a double-ended priority queue" and immediately dove into the min-max heap data structure internals.
After:
Heap## Implementation DetailssectionChecklist