From 18ad465814c3007c75ff4d73ea8c229daa5b7b73 Mon Sep 17 00:00:00 2001
From: Thomas Guettler <thomas.guettler@syself.com>
Date: Thu, 13 Jul 2023 20:08:24 +0200
Subject: [PATCH] :seedling: Extend docs for patch.NewHelper

---
 util/patch/patch.go | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/util/patch/patch.go b/util/patch/patch.go
index a6559f6cd4d1..dcf693495edd 100644
--- 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) {