docs: add documentation for public method

evgeniy-scherbina · evgeniy-scherbina · commit 137c97768d0b · 2025-02-13T09:55:09.000-05:00
diff --git a/cli/cliui/output.go b/cli/cliui/output.go
@@ -83,6 +83,8 @@ func (f *OutputFormatter) Format(ctx context.Context, data any) (string, error)
 	return "", xerrors.Errorf("unknown output format %q", f.formatID)
 }
 
+// FormatID will return the ID of the format selected by `--output`.
+// If no flag is present, it returns the 'default' formatter.
 func (f *OutputFormatter) FormatID() string {
 	return f.formatID
 }

Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,8 @@ func (f *OutputFormatter) Format(ctx context.Context, data any) (string, error)`
`83`	`83`	`return "", xerrors.Errorf("unknown output format %q", f.formatID)`
`84`	`84`	`}`
`85`	`85`
	`86`	+// FormatID will return the ID of the format selected by `--output`.
	`87`	`+// If no flag is present, it returns the 'default' formatter.`
`86`	`88`	`func (f *OutputFormatter) FormatID() string {`
`87`	`89`	`return f.formatID`
`88`	`90`	`}`