Add comments

Emyrk · Emyrk · commit 82258ef25968 · 2023-04-18T09:34:30.000-05:00
diff --git a/cli/clibase/option.go b/cli/clibase/option.go
@@ -80,6 +80,7 @@ func (s *OptionSet) Add(opts ...Option) {
 	*s = append(*s, opts...)
 }
 
+// Filter will only return options that match the given filter. (return true)
 func (s OptionSet) Filter(filter func(opt Option) bool) OptionSet {
 	cpy := make(OptionSet, 0)
 	for _, opt := range s {
diff --git a/cli/cliui/output.go b/cli/cliui/output.go
@@ -193,6 +193,11 @@ func (textFormat) Format(_ context.Context, data any) (string, error) {
 	return fmt.Sprintf("%s", data), nil
 }
 
+// DataChangeFormat allows manipulating the data passed to an output format.
+// This is because sometimes the data needs to be manipulated before it can be
+// passed to the output format.
+// For example, you may want to pass something different to the text formatter
+// than what you pass to the json formatter.
 type DataChangeFormat struct {
 	format OutputFormat
 	change func(data any) (any, error)

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,7 @@ func (s *OptionSet) Add(opts ...Option) {`
`80`	`80`	`s = append(s, opts...)`
`81`	`81`	`}`
`82`	`82`
	`83`	`+// Filter will only return options that match the given filter. (return true)`
`83`	`84`	`func (s OptionSet) Filter(filter func(opt Option) bool) OptionSet {`
`84`	`85`	`cpy := make(OptionSet, 0)`
`85`	`86`	`for _, opt := range s {`