Clarify doc comments

solo-io · Aug 7, 2024 · 9c8ba40 · 9c8ba40
1 parent 3346dc5
commit 9c8ba40
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/codegen/collector/executor.go b/codegen/collector/executor.go
@@ -84,7 +84,7 @@ type OpenApiProtocExecutor struct {
 	// Type and Required markers will be included regardless
 	DisableKubeMarkers bool
 
-	// A list of kube markers that should be ignored while generating an open api schema
+	// A list of kube markers that should be ignored while generating an open api schema. If empty, no kube markers will be ignored.
 	IgnoredKubeMarkers []string
 }
 

diff --git a/codegen/proto/schemagen/generator.go b/codegen/proto/schemagen/generator.go
@@ -23,7 +23,7 @@ type ValidationSchemaOptions struct {
 	// Default: false
 	DisableKubeMarkers bool
 
-	// A list of kube markers that should be ignored while generating an open api schema
+	// A list of kube markers that should be ignored while generating an open api schema. If empty, no kube markers will be ignored.
 	IgnoredKubeMarkers []string
 }