From 8b8ae5b264ae566d2bec12a455b08ed23ffc26b6 Mon Sep 17 00:00:00 2001
From: Hannes Gustafsson <hannes.gustafsson@commercetools.com>
Date: Thu, 5 Sep 2024 15:12:19 +0100
Subject: [PATCH] Update doc comment

---
 internal/pkg/argocd/argocd.go | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/internal/pkg/argocd/argocd.go b/internal/pkg/argocd/argocd.go
index 87c6910..d4b689f 100644
--- a/internal/pkg/argocd/argocd.go
+++ b/internal/pkg/argocd/argocd.go
@@ -149,7 +149,8 @@ func generateArgocdAppDiff(ctx context.Context, keepDiffData bool, app *argoappv
 	return foundDiffs, diffElements, nil
 }
 
-// Should return output that is compatible with github markdown diff highlighting format
+// diffLiveVsTargetObject returns the diff of live and target in a format that
+// is compatible with Github markdown diff highlighting.
 func diffLiveVsTargetObject(live, target *unstructured.Unstructured) (string, error) {
 	a, err := yaml2.Marshal(live)
 	if err != nil {