qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-26 22:51:23 -07:00
Code Releases Activity

container/heap: fix comments style

Browse Source 
Fixes golint warning about comment on exported function.

Change-Id: Ia6a910e2dca2cd31d8de64419e36add6191e804d
Reviewed-on: https://go-review.googlesource.com/105495
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
This commit is contained in:
bontequero 2018-04-07 20:43:45 +03:00 committed by Brad Fitzpatrick
parent e21a749af1
commit 641c32264c
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/container/heap/heap.go
View File

@ -18,7 +18,9 @@ package heap
import "sort"
// Any type that implements heap.Interface may be used as a
// The Interface type describes the requirements
// for a type using the routines in this package.
// Any type that implements it may be used as a
// min-heap with the following invariants (established after
// Init has been called or if the data is empty or sorted):
//
@ -33,11 +35,10 @@ type Interface interface {
Pop() interface{} // remove and return element Len() - 1.
}
// A heap must be initialized before any of the heap operations
// can be used. Init is idempotent with respect to the heap invariants
// Init establishes the heap invariants required by the other routines in this package.
// Init is idempotent with respect to the heap invariants
// and may be called whenever the heap invariants may have been invalidated.
// Its complexity is O(n) where n = h.Len().
//
func Init(h Interface) {
// heapify
n := h.Len()