Sync more changes in rule docs#431
Merged
sdwheeler merged 1 commit intoJun 26, 2026
Merged
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 2d333dd: ✅ Validation status: passed
For more details, please refer to the build report. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates and synchronizes several PSScriptAnalyzer rule reference documents to improve clarity, correctness, and consistency in guidance for module authors and script analysis users.
Changes:
- Clarifies export-field guidance (including using
@()instead of$null) and fixes/standardizes wording across multiple rule docs. - Corrects/standardizes phrasing around PowerShell platform identifiers and compatibility descriptions.
- Cleans up the rules index README text and fixes Markdown formatting in a NOTE block.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md | Adds explicit guidance to use empty arrays for no-export scenarios to avoid autodiscovery costs. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md | Refines wording describing PowerShell platform name format. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md | Refines wording describing PowerShell platform name format. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md | Updates configuration example and parameter wording for compatibility targeting. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md | Fixes grammatical issue in the rule description. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md | Removes redundant text and updates wording in the rules index introduction. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md | Improves clarity on required manifest key/value expectations. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md | Fixes NOTE block formatting so it renders correctly. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
9
to
+12
| The PSScriptAnalyzer module includes the following built-in rule definitions. For rules that | ||
| support settings, you can enable or disable them by setting the `Enable` configuration property in | ||
| a custom settings file. Rules listed as _Always enabled_ don't expose a per-rule `Enable` property. | ||
| There are two way to avoid using these rules: | ||
| There are two ways to avoid using these rules: |
sdwheeler
added a commit
that referenced
this pull request
Jun 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
Sync more changes in rule docs
PR Checklist