Skip to content

Commit ade730a

Browse files
cuishuanggopherbot
authored andcommitted
container/heap: add available godoc link
Change-Id: I886a8869ba885286ac8219bc7e245c9237ad4c99 Reviewed-on: https://go-review.googlesource.com/c/go/+/534777 Reviewed-by: Ian Lance Taylor <[email protected]> TryBot-Result: Gopher Robot <[email protected]> Reviewed-by: Dmitri Shuralyov <[email protected]> Run-TryBot: shuang cui <[email protected]> Auto-Submit: Ian Lance Taylor <[email protected]>
1 parent cf97cd3 commit ade730a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/container/heap/heap.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ import "sort"
2121
// for a type using the routines in this package.
2222
// Any type that implements it may be used as a
2323
// min-heap with the following invariants (established after
24-
// Init has been called or if the data is empty or sorted):
24+
// [Init] has been called or if the data is empty or sorted):
2525
//
2626
// !h.Less(j, i) for 0 <= i < h.Len() and 2*i+1 <= j <= 2*i+2 and j < h.Len()
2727
//
28-
// Note that Push and Pop in this interface are for package heap's
28+
// Note that [Push] and [Pop] in this interface are for package heap's
2929
// implementation to call. To add and remove things from the heap,
30-
// use heap.Push and heap.Pop.
30+
// use [heap.Push] and [heap.Pop].
3131
type Interface interface {
3232
sort.Interface
3333
Push(x any) // add x as element Len()
@@ -55,7 +55,7 @@ func Push(h Interface, x any) {
5555

5656
// Pop removes and returns the minimum element (according to Less) from the heap.
5757
// The complexity is O(log n) where n = h.Len().
58-
// Pop is equivalent to Remove(h, 0).
58+
// Pop is equivalent to [Remove](h, 0).
5959
func Pop(h Interface) any {
6060
n := h.Len() - 1
6161
h.Swap(0, n)
@@ -78,7 +78,7 @@ func Remove(h Interface, i int) any {
7878

7979
// Fix re-establishes the heap ordering after the element at index i has changed its value.
8080
// Changing the value of the element at index i and then calling Fix is equivalent to,
81-
// but less expensive than, calling Remove(h, i) followed by a Push of the new value.
81+
// but less expensive than, calling [Remove](h, i) followed by a Push of the new value.
8282
// The complexity is O(log n) where n = h.Len().
8383
func Fix(h Interface, i int) {
8484
if !down(h, i, h.Len()) {

0 commit comments

Comments
 (0)