fix: document ValidateFields

gravitational · Jan 8, 2025 · 839b31b · 839b31b
1 parent 95ca8b2
commit 839b31b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/utils/log/slog.go b/lib/utils/log/slog.go
@@ -128,6 +128,8 @@ var knownFormatFields = map[string]struct{}{
 	TimestampField: {},
 }
 
+// ValidateFields ensures the provided fields map to the allowed fields. An error
+// is returned if any of the fields are invalid.
 func ValidateFields(formatInput []string) (result []string, err error) {
 	for _, component := range formatInput {
 		component = strings.TrimSpace(component)