Apply suggestions from code review

Co-authored-by: Hannes Gustafsson <hnnsgstfssn@gmail.com>

Remove some uneeded comments
Simplify tests function

Address lint issue

internal/pkg/githubapi/github.go

@@ -241,15 +241,12 @@ func generateArgoCdDiffComments(diffCommentData DiffCommentData, githubCommentMa
 	// If the diff comment is too large, we'll split it into multiple comments, one per component
 	totalComponents := len(diffCommentData.DiffOfChangedComponents)
 	for i, singleComponentDiff := range diffCommentData.DiffOfChangedComponents {
-		// We take the diffCommentData and replace the DiffOfChangedComponents with a single component diff
 		componentTemplateData := diffCommentData
 		componentTemplateData.DiffOfChangedComponents = []argocd.DiffResult{singleComponentDiff}
-
-		// We also update the header to reflect the current component.
 		componentTemplateData.Header = fmt.Sprintf("Component %d/%d: %s (Split for comment size)", i+1, totalComponents, singleComponentDiff.ComponentPath)
 		err, templateOutput := executeTemplate("argoCdDiff", "argoCD-diff-pr-comment.gotmpl", componentTemplateData)
 		if err != nil {
-			return comments, fmt.Errorf("failed to generate ArgoCD diff comment template: %w", err)
+			return nil, fmt.Errorf("failed to generate ArgoCD diff comment template: %w", err)
 		}
 
 		// Even per component comments can be too large, in that case we'll just use the concise template

internal/pkg/githubapi/github_test.go

@@ -192,10 +192,7 @@ func TestGenerateArgoCdDiffComments(t *testing.T) {
 		t.Run(name, func(t *testing.T) {
 			t.Parallel()
 			var diffCommentData DiffCommentData
-			err := readJSONFromFile(t, tc.diffCommentDataTestDataFileName, &diffCommentData)
-			if err != nil {
-				t.Errorf("Error reading test data file: %s", err)
-			}
+			readJSONFromFile(t, tc.diffCommentDataTestDataFileName, &diffCommentData)
 
 			result, err := generateArgoCdDiffComments(diffCommentData, tc.maxCommentLength)
 			if err != nil {
@@ -213,20 +210,19 @@ func TestGenerateArgoCdDiffComments(t *testing.T) {
 	}
 }
 
-func readJSONFromFile(t *testing.T, filename string, data interface{}) error {
+func readJSONFromFile(t *testing.T, filename string, data interface{}) {
 	t.Helper()
 	// Read the JSON from the file
 	jsonData, err := os.ReadFile(filename)
 	if err != nil {
-		return err
+		t.Fatalf("Error loading test data file: %s", err)
 	}
 
 	// Unserialize the JSON into the provided struct
 	err = json.Unmarshal(jsonData, data)
 	if err != nil {
-		return err
+		t.Fatalf("Error unmarshalling JSON: %s", err)
 	}
-	return nil
 }
 
 func TestPrBody(t *testing.T) {