chore: apply suggestions from code review (batch 1)

Co-authored-by: ccoVeille <3875889+ccoVeille@users.noreply.github.com>
Signed-off-by: Atomys <contact@atomys.fr>

tools/docvalidator/main.go

@@ -1,5 +1,5 @@
 // Package main provides a utility to process markdown documentation files,
-// extract code examples, execute them, and verify their outputs.
+// extracts code examples, executes them, and verifies their outputs.
 package main
 
 import (
@@ -82,8 +82,8 @@ func run(fs FileSystem) error {
 	})
 
 	if len(files) == 0 {
-		slog.Error("No markdown files found in docs directory.")
-		return fmt.Errorf("no markdown files found in docs directory")
+		slog.Error("No Markdown files found in docs directory.")
+		return fmt.Errorf("no Markdown files found in docs directory")
 	}
 
 	var examples []Example
@@ -118,10 +118,9 @@ func run(fs FileSystem) error {
 	if errCount > 0 {
 		slog.Error("Failed to process some examples", "count", errCount)
 		return fmt.Errorf("failed to process %d examples", errCount)
-	} else {
-		slog.Info("All examples processed successfully")
-		return nil
 	}
+	slog.Info("All examples processed successfully")
+	return nil
 }
 
 // filterFiles filters out unwanted files from the provided list of files.

tools/docvalidator/parsing.go

@@ -8,8 +8,8 @@ import (
 )
 
 // extractExamples scans the content of a markdown file and extracts code examples.
-// It returns a slice of Example structs, each representing a code example found in the content.
-// This function is used to parse markdown files and find code examples under specific headings.
+// It returns a slice of [Example] structs, each representing a code example found in the content.
+// This function is used to parse Markdown files and find code examples under specific headings.
 func extractExamples(content, filePath string) []Example {
 	var examples []Example
 

tools/docvalidator/processing_test.go

@@ -71,7 +71,6 @@ func TestProcessExample_ErrorExceptedButNoError(t *testing.T) {
 		Expected: "Error",
 	}
 	err := processExample(example)
-	require.Error(t, err)
 	assert.ErrorContains(t, err, "expected an error but the template executed successfully")
 }
 
@@ -85,7 +84,6 @@ func TestProcessExample_ErrorUnexpected(t *testing.T) {
 		Expected: "1",
 	}
 	err := processExample(example)
-	require.Error(t, err)
 	assert.ErrorContains(t, err, "unexpected error during template execution")
 }
 
@@ -100,6 +98,5 @@ func TestProcessExample_OutputMismatch(t *testing.T) {
 		Expected: "Hello, World!",
 	}
 	err := processExample(example)
-	require.Error(t, err)
 	assert.ErrorContains(t, err, "output mismatch")
 }