Skip to content

Commit

Permalink
Clarify Result docs
Browse files Browse the repository at this point in the history
Signed-off-by: Eric Chlebek <eric@sensu.io>
  • Loading branch information
echlebek committed Dec 10, 2020
1 parent c1c14fd commit 6afc191
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions errcheck/errcheck.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,11 @@ type UncheckedError struct {
FuncName string
}

// Result is returned from the CheckPackage function if the package contains
// any unchecked errors.
// Result is returned from the CheckPackage function, and holds all the errors
// that were found to be unchecked in a package.
//
// Aggregation can be done using the Append method.
// Aggregation can be done using the Append method for users that want to
// combine results from multiple packages.
type Result struct {
// UncheckedErrors is a list of all the unchecked errors in the package.
// Printing an error reports its position within the file and the contents of the line.
Expand Down

0 comments on commit 6afc191

Please sign in to comment.