code review

kubernetes-sigs · Jun 1, 2021 · 23544e0 · 23544e0
1 parent b1fda3d
commit 23544e0
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/api/resource/factory.go b/api/resource/factory.go
@@ -23,9 +23,10 @@ import (
 type Factory struct {
 	hasher ifc.KustHasher
 
-	// IncludeLocalConfigs indicates should resource factory ignore
-	// the resources which have annotation 'config.kubernetes.io/local-config'.
-	// By default it's false.
+	// When set to true, IncludeLocalConfigs indicates
+	// that Factory should include resources with the
+	// annotation 'config.kubernetes.io/local-config'.
+	// By default these resources are ignored.
 	IncludeLocalConfigs bool
 }