Skip to content

Commit

Permalink
fix incorrect documentation for the WithShowErrors method (charmbra…
Browse files Browse the repository at this point in the history
…celet#102)

* fix documentation

* better wording
  • Loading branch information
theredditbandit authored and ardnew committed Apr 9, 2024
1 parent 25ce627 commit fe5656e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions form.go
Original file line number Diff line number Diff line change
Expand Up @@ -202,10 +202,10 @@ func (f *Form) WithShowHelp(v bool) *Form {
return f
}

// WithShowErrors sets whether or not the form should show help.
// WithShowErrors sets whether or not the form should show errors.
//
// This allows the form groups and field to show what keybindings are available
// to the user.
// This allows the form groups and fields to show errors when the Validate
// function returns an error.
func (f *Form) WithShowErrors(v bool) *Form {
for _, group := range f.groups {
group.WithShowErrors(v)
Expand Down

0 comments on commit fe5656e

Please sign in to comment.