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

Heap documentation does not explain what a heap is #324

Closed
lorentey opened this issue Nov 13, 2023 · 0 comments
Closed

Heap documentation does not explain what a heap is #324

lorentey opened this issue Nov 13, 2023 · 0 comments
Assignees
@lorentey
Labels
enhancement New feature or request Heap Min-max heap module
Milestone
1.1.0

Comments

@lorentey
Copy link
Member

lorentey commented Nov 13, 2023 •
edited

The current type documentation for Heap links to wikipedia for a definition of a min-max heap. This isn't ideal; rather, the doc comment needs to directly include a succinct description of what a heap is (in terms that are familiar to Swift engineers), including some rudimentary code samples exercising its operations.

rdar://118368503
@lorentey lorentey added enhancement New feature or request Heap Min-max heap module labels Nov 13, 2023
@lorentey lorentey added this to the 1.1.0 milestone Nov 13, 2023
@lorentey lorentey self-assigned this Nov 13, 2023
@lorentey lorentey mentioned this issue Nov 14, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lorentey lorentey

Labels
enhancement New feature or request Heap Min-max heap module
Projects
None yet
Milestone
1.1.0
Development

No branches or pull requests
1 participant
@lorentey