[Heap] Improve type-level doc comment

lorentey commented 6 months ago

Resolves #324.

rdar://118368503

[X] I've read the Contribution Guidelines
[X] My contributions are licensed under the Swift license.
[X] I've followed the coding style of the rest of the project.
[ ] I've added tests covering all new code paths my change adds to the project (if appropriate).
[ ] I've added benchmarks covering new functionality (if appropriate).
[X] I've verified that my change does not break any existing tests or introduce unexplained benchmark regressions.
[X] I've updated the documentation if necessary.

lorentey commented 6 months ago

@swift-ci test

lorentey commented 6 months ago

macOS PR tests are expected to fail due to rdar://117169742. This is fine. 🔥

lorentey commented 6 months ago

@jmschonfeld @glessard @Azoy This is a quick attempt at writing some minimal docs -- fresh eyes are welcome!

lorentey commented 6 months ago

@swift-ci test

apple / swift-collections