Update doc comment

commercetools · Sep 5, 2024 · 8b8ae5b · 8b8ae5b
1 parent bfdfa49
commit 8b8ae5b
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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 {