Merge pull request #9001 from guettli/patch-NewHelper-docs

🌱 Extend docs for patch.NewHelper
kubernetes-sigs · Jul 13, 2023 · 0cbde4a · 0cbde4a
2 parents 6acff21 + 18ad465
commit 0cbde4a
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/util/patch/patch.go b/util/patch/patch.go
@@ -48,7 +48,8 @@ type Helper struct {
 	isConditionsSetter bool
 }
 
-// NewHelper returns an initialized Helper.
+// NewHelper returns an initialized Helper. Use NewHelper before changing
+// obj. After changing obj use Helper.Patch to persist your changes.
 func NewHelper(obj client.Object, crClient client.Client) (*Helper, error) {
 	// Return early if the object is nil.
 	if util.IsNil(obj) {