Skip to content

Commit

Permalink
doc(errors): mention RegisterTagNameFunc for FieldError.Field
Browse files Browse the repository at this point in the history
  • Loading branch information
khan-ajamal committed Jan 6, 2025
1 parent 6c3307e commit bba37c3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ type FieldError interface {
// Field returns the fields name with the tag name taking precedence over the
// field's actual name.
//
// `RegisterTagNameFunc` must be registered to get tag value.
//
// eq. JSON name "fname"
// see StructField for comparison
Field() string
Expand Down

0 comments on commit bba37c3

Please sign in to comment.