Skip to content

Heap documentation does not explain what a heap is #324

@lorentey

Description

@lorentey

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

Metadata

Metadata

Assignees

Labels

HeapMin-max heap moduleenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions