Add docs for flags.Required()

auth0 · Mar 20, 2021 · fa79f50 · fa79f50
1 parent 31dd394
commit fa79f50
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/internal/cli/flags.go b/internal/cli/flags.go
@@ -15,6 +15,9 @@ type Flag struct {
 	IsRequired bool
 }
 
+// Required clones an existing flag and assigns `IsRequired` to true. This is
+// useful when there are flags with several different use cases -- e.g. create
+// requiring the flag, but update not requiring it.
 func (f *Flag) Required() *Flag {
 	clone := *f
 	clone.IsRequired = true