Add comments to exported in types

This commit is contained in:
stuart nelson 2016-08-24 17:46:46 +02:00
parent 9cf1d2554d
commit 85f96e3449
1 changed files with 8 additions and 0 deletions

View File

@ -280,29 +280,37 @@ var (
endsAt SortKey = "endsAt" endsAt SortKey = "endsAt"
) )
// ByCreatedAt sorts compares CreatedAt times for silences.
func ByCreatedAt(i, j *Silence) bool { func ByCreatedAt(i, j *Silence) bool {
return i.CreatedAt.After(j.CreatedAt) return i.CreatedAt.After(j.CreatedAt)
} }
// ByStartsAt sorts compares StartsAt times for silences.
func ByStartsAt(i, j *Silence) bool { func ByStartsAt(i, j *Silence) bool {
return i.StartsAt.After(j.StartsAt) return i.StartsAt.After(j.StartsAt)
} }
// ByEndsAt sorts compares EndsAt times for silences.
func ByEndsAt(i, j *Silence) bool { func ByEndsAt(i, j *Silence) bool {
return i.EndsAt.After(j.EndsAt) return i.EndsAt.After(j.EndsAt)
} }
// SilenceLessFuncs provides a typesafe way to take user input and select a
// SilencesLessFunc.
var SilenceLessFuncs = map[SortKey]SilencesLessFunc{ var SilenceLessFuncs = map[SortKey]SilencesLessFunc{
createdAt: ByCreatedAt, createdAt: ByCreatedAt,
startsAt: ByStartsAt, startsAt: ByStartsAt,
endsAt: ByEndsAt, endsAt: ByEndsAt,
} }
// SilencesSorter implements the sort interface to sort a slice of silences
// according to less.
type SilencesSorter struct { type SilencesSorter struct {
silences []*Silence silences []*Silence
less SilencesLessFunc less SilencesLessFunc
} }
// NewSilencesSorter returns a new SilencesSorter.
func NewSilencesSorter(s []*Silence, fn SilencesLessFunc) *SilencesSorter { func NewSilencesSorter(s []*Silence, fn SilencesLessFunc) *SilencesSorter {
return &SilencesSorter{ return &SilencesSorter{
silences: s, silences: s,