Sync PSSA docs changes from repo#445
Conversation
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 0857dba: ✅ Validation status: passed
For more details, please refer to the build report. |
There was a problem hiding this comment.
Pull request overview
Syncs documentation updates for PSScriptAnalyzer rules, aligning rule parameter descriptions and configuration guidance with upstream changes.
Changes:
- Updates
UseSingularNounsdocumentation to reflectNounAllowListas a string array. - Updates
UseConsistentParametersKinddocumentation date and addsParametersKindconfiguration/description.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md | Updates NounAllowList parameter description to reflect array usage and default behavior. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md | Adds ParametersKind configuration guidance and parameter documentation; updates ms.date. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| This parameter specifies which noun commands to exclude from this rule. It accepts a string array. | ||
| Both `Data` and `Windows` are common false positives and excluded by default. Default values are | ||
| `'Data'` and `'Windows'`. |
| This parameter controls whether ScriptAnalyzer checks the code against this rule. It accepts a | ||
| boolean value. To enable this rule, set this parameter to `$true`. The default value is `$false`. | ||
|
|
||
| ## ParametersKind |
PR Summary
Sync PSSA docs changes from repo
PR Checklist