Skip to content

Commit

Permalink
Document StorageReader interface (sourcegraph#60)
Browse files Browse the repository at this point in the history
Document StorageReader interface as suggested by @shurcooL in
sourcegraph#58
  • Loading branch information
McKael authored and mholt committed Aug 18, 2017
1 parent 99bfc76 commit ed8b73a
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion checkup.go
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,10 @@ type Storage interface {

// StorageReader can read results from the Storage.
type StorageReader interface {
Fetch(string) ([]Result, error)
// Fetch returns the contents of a check file.
Fetch(checkFile string) ([]Result, error)
// GetIndex returns the storage index, as a map where keys are check
// result filenames and values are the associated check timestamps.
GetIndex() (map[string]int64, error)
}

Expand Down

0 comments on commit ed8b73a

Please sign in to comment.