🩹[Patch]: Improve error handling and output error summary (#23)

MariusStorhaug · web-flow · commit aa32aa107eb2 · 2025-10-07T13:00:57.000+02:00
## Description

This pull request makes a minor improvement to error handling in the
PowerShell documentation build script. Instead of writing errors as
errors, it now logs them as warnings with more context when markdown
help generation fails for a command.

* Improved error reporting by changing `Write-Error` to `Write-Warning`
with a descriptive message in `Build-PSModuleDocumentation.ps1`.
diff --git a/scripts/helpers/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build-PSModuleDocumentation.ps1
@@ -85,7 +85,7 @@
                     Error       = $_
                     ErrorString = $_.ToString()
                 })
-            Write-Error $_
+            Write-Warning "Failed to generate markdown help for $($command.Name): $_"
         }
     }
     Write-Host '::endgroup::'

Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@`
`85`	`85`	`Error = $_`
`86`	`86`	`ErrorString = $_.ToString()`
`87`	`87`	`})`
`88`		`- Write-Error $_`
	`88`	`+ Write-Warning "Failed to generate markdown help for $($command.Name): $_"`
`89`	`89`	`}`
`90`	`90`	`}`
`91`	`91`	`Write-Host '::endgroup::'`