Resolved formatting issues in the magefile comments

docs/docGeneration.go

@@ -392,7 +392,6 @@ func createFunctionDoc(fset *token.FileSet, fn *ast.FuncDecl) (FunctionDoc, erro
 
 	// Extract receiver (struct) name
 	if fn.Recv != nil && len(fn.Recv.List) > 0 {
-		// The receiver expression is of type *ast.StarExpr when it's a pointer
 		if se, ok := fn.Recv.List[0].Type.(*ast.StarExpr); ok {
 			structName = fmt.Sprintf("%s.", se.X)
 		} else {

magefiles/README.md

@@ -1,7 +1,6 @@
 # goutils/v2/magefiles
 
-
-`magefiles` provide utilities that would normally be managed
+`magefiles` provides utilities that would normally be managed
 and executed with a `Makefile`.
 Table of contents:
 
@@ -65,10 +64,9 @@ RunPreCommit() error
 RunPreCommit updates, clears, and executes all pre-commit hooks
 locally. The function follows a three-step process:
 
- 1. Updates the pre-commit hooks using lint.UpdatePCHooks.
- 2. Clears the pre-commit cache with lint.ClearPCCache to ensure
-    a clean environment.
- 3. Executes all pre-commit hooks locally using lint.RunPCHooks.
+First, it updates the pre-commit hooks.
+Next, it clears the pre-commit cache to ensure a clean environment.
+Lastly, it executes all pre-commit hooks locally.
 
 Example usage:
 
@@ -155,7 +153,6 @@ error: an error if one occurred
 
 ---
 
-
 ## Contributing
 
 Pull requests are welcome. For major changes,

magefiles/magefile.go

@@ -91,10 +91,9 @@ func GeneratePackageDocs() error {
 // RunPreCommit updates, clears, and executes all pre-commit hooks
 // locally. The function follows a three-step process:
 //
-//  1. Updates the pre-commit hooks using lint.UpdatePCHooks.
-//  2. Clears the pre-commit cache with lint.ClearPCCache to ensure
-//     a clean environment.
-//  3. Executes all pre-commit hooks locally using lint.RunPCHooks.
+// First, it updates the pre-commit hooks.
+// Next, it clears the pre-commit cache to ensure a clean environment.
+// Lastly, it executes all pre-commit hooks locally.
 //
 // Example usage:
 //

magefiles/tmpl/README.md.tmpl

@@ -2,8 +2,7 @@
 
 {{if ne .PackageName "magefiles"}}The `{{.PackageName}}` package is a collection of utility functions
 designed to simplify common {{.PackageName}} tasks.
-{{else}}
-`{{.PackageName}}` provide utilities that would normally be managed
+{{else}}`{{.PackageName}}` provides utilities that would normally be managed
 and executed with a `Makefile`.{{end}}
 Table of contents:
 
@@ -58,8 +57,8 @@ command to execute the tests for `goutils/v2/{{.PackageName}}`:
 go test -v
 ```
 
----{{end}}
-
+---
+{{end}}
 ## Contributing
 
 Pull requests are welcome. For major changes,