Issue 24751 - [std.container.binaryheap] example uses heapify but there is no documentation
Summary: [std.container.binaryheap] example uses heapify but there is no documentation
Status: RESOLVED INVALID
Alias: None
Product: D
Classification: Unclassified
Component: phobos (show other issues)
Version: D2
Hardware: All All
: P3 enhancement
Assignee: No Owner
URL: http://dlang.org/phobos/
Keywords:
Depends on:
Blocks:
 
Reported: 2024-09-07 22:50 UTC by ppadilcdx
Modified: 2024-09-08 21:57 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description ppadilcdx 2024-09-07 22:50:16 UTC
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 Nick Treleaven 2024-09-08 20:20:49 UTC
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 ppadilcdx 2024-09-08 21:01:19 UTC
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.