← Back to index | Original Bugzilla link

Bug 24751 – [std.container.binaryheap] example uses heapify but there is no documentation

Status: RESOLVED
Resolution: INVALID
Severity: enhancement
Priority: P3
Component: phobos
Product: D
Version: D2
Platform: All
OS: All
Creation time: 2024-09-07T22:50:16Z
Last change time: 2024-09-08T21:57:08Z
Assigned to: No Owner
Creator: ppadilcdx

Comments

Comment #0 by ppadilcdx — 2024-09-07T22:50:16Z

The std doc page for [std.container.binaryheap] example uses a routine named "heapify" but there is no documentation about it in the page with the rest of the functions. Users have to look at the source to figure out where this function came from.

Comment #1 by nick — 2024-09-08T20:20:49Z

The ddoc page does list it: https://dlang.org/phobos/std_container_binaryheap.html ddox lists it here: https://dlang.org/library-prerelease/std/container/binaryheap.html This sub-page doesn't (but that's the intended design of ddox): https://dlang.org/library-prerelease/std/container/binaryheap/binary_heap.html

Comment #2 by ppadilcdx — 2024-09-08T21:01:19Z

You are right - my bad. I'll blame it on not enough coffee. Feel free to delete, mark complete or whatever is the appropriate way to dispose of this report. Thank you.