Component: Documentation
Bug Description
scripts/linting/README.md documents Invoke-LinkLanguageCheck.ps1 (lines 184–211) but does not include a Parameters section. PR #1229 added a new -OutputPath parameter to the script, and neither OutputPath nor the pre-existing -ExcludePaths parameter are documented in the README.
What the documentation currently says:
The section for Invoke-LinkLanguageCheck.ps1 contains only a Features list and two usage examples (-Verbose, -Debug). No parameters are listed.
What changed in code (PR #1229 / commit 2aad98e):
- Added
-OutputPath parameter (default: "logs/link-lang-check-results.json") to Invoke-LinkLanguageCheck.ps1
- The output path is now configurable; the script creates the output directory if it does not exist
- Updated the inner
Invoke-LinkLanguageCheckCore function to accept and forward OutputPath
Expected Behavior
scripts/linting/README.md should include a Parameters section under Invoke-LinkLanguageCheck.ps1 that documents:
-ExcludePaths (string array, optional) — paths to exclude from the check
-OutputPath (string, optional, default "logs/link-lang-check-results.json") — path where the JSON result file is written; parent directory is created automatically if it does not exist
The Usage section should also include an example showing a custom output path, e.g.:
# Write results to a custom location
./scripts/linting/Invoke-LinkLanguageCheck.ps1 -OutputPath "custom/results.json"
Steps to Reproduce
- Open
scripts/linting/README.md
- Navigate to the
Invoke-LinkLanguageCheck.ps1 section (around line 184)
- Observe that no Parameters section exists and
-OutputPath is not mentioned
Additional Context
Generated by Documentation Update Check · ◷
Component: Documentation
Bug Description
scripts/linting/README.mddocumentsInvoke-LinkLanguageCheck.ps1(lines 184–211) but does not include a Parameters section. PR #1229 added a new-OutputPathparameter to the script, and neitherOutputPathnor the pre-existing-ExcludePathsparameter are documented in the README.What the documentation currently says:
The section for
Invoke-LinkLanguageCheck.ps1contains only a Features list and two usage examples (-Verbose,-Debug). No parameters are listed.What changed in code (PR #1229 / commit
2aad98e):-OutputPathparameter (default:"logs/link-lang-check-results.json") toInvoke-LinkLanguageCheck.ps1Invoke-LinkLanguageCheckCorefunction to accept and forwardOutputPathExpected Behavior
scripts/linting/README.mdshould include a Parameters section underInvoke-LinkLanguageCheck.ps1that documents:-ExcludePaths(string array, optional) — paths to exclude from the check-OutputPath(string, optional, default"logs/link-lang-check-results.json") — path where the JSON result file is written; parent directory is created automatically if it does not existThe Usage section should also include an example showing a custom output path, e.g.:
Steps to Reproduce
scripts/linting/README.mdInvoke-LinkLanguageCheck.ps1section (around line 184)-OutputPathis not mentionedAdditional Context
scripts/linting/Invoke-LinkLanguageCheck.ps1scripts/linting/README.md(lines 184–211)2aad98e