knative
/
pkg
mirror of https://github.com/knative/pkg.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add comments to exported error helpers. (#20) 

Noticed via the go report!
This commit is contained in:
Matt Moore 2018-07-26 16:40:35 -07:00 committed by Google Prow Robot
parent 63b563207a
commit 84f0a719d7
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
apis/field_error.go
View File

@ -85,6 +85,7 @@ func (fe *FieldError) Error() string {
return fmt.Sprintf("%v: %v\n%v", fe.Message, strings.Join(fe.Paths, ", "), fe.Details) return fmt.Sprintf("%v: %v\n%v", fe.Message, strings.Join(fe.Paths, ", "), fe.Details)
} }
// ErrMissingField is a variadic helper method for constructing a FieldError for a set of missing fields.
func ErrMissingField(fieldPaths ...string) *FieldError { func ErrMissingField(fieldPaths ...string) *FieldError {
return &FieldError{ return &FieldError{
Message: "missing field(s)", Message: "missing field(s)",
@ -92,6 +93,7 @@ func ErrMissingField(fieldPaths ...string) *FieldError {
} }
} }
// ErrDisallowedFields is a variadic helper method for constructing a FieldError for a set of disallowed fields.
func ErrDisallowedFields(fieldPaths ...string) *FieldError { func ErrDisallowedFields(fieldPaths ...string) *FieldError {
return &FieldError{ return &FieldError{
Message: "must not set the field(s)", Message: "must not set the field(s)",
@ -99,6 +101,7 @@ func ErrDisallowedFields(fieldPaths ...string) *FieldError {
} }
} }
// ErrInvalidValue constructs a FieldError for a field that has received an invalid string value.
func ErrInvalidValue(value string, fieldPath string) *FieldError { func ErrInvalidValue(value string, fieldPath string) *FieldError {
return &FieldError{ return &FieldError{
Message: fmt.Sprintf("invalid value %q", value), Message: fmt.Sprintf("invalid value %q", value),