Poorly chosen name for error variable SCC-ST1012
Style
Minor
3 months ago
—
2 years old
error var InternalServerError should have name of the form ErrFoo
6
7import "errors"
8
9var InternalServerError = errors.New("internal server error")10
11// New is a wrapper of real errors.New function.
12func New(text string) error {
Description
The error variable name should be chosen carefully to convey the meaning of the error. It is recommended to use names like errFoo, ErrSomethingBad, ErrKindFoo or BazError for error variables that are part of an API.
Examples:
Bad practice
_, e := ioutil.ReadFile("file.txt")
if e != nil {
log.Fatal(e)
}
Recommended
_, err := ioutil.ReadFile("file.txt")
if err != nil {
log.Fatal(err)
}
Reference: Effective Go - Errors