apple / swift-collections

Commonly used data structures for Swift
Apache License 2.0
3.55k stars 270 forks source link

`Heap` documentation does not explain what a heap is #324

Closed lorentey closed 4 months ago

lorentey commented 6 months ago

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