Sync docs changes with source repo#429
Merged
sdwheeler merged 2 commits intoJun 25, 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 |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR syncs PSScriptAnalyzer rule documentation pages in reference/docs-conceptual/PSScriptAnalyzer/Rules/ with updates from the upstream/source repo, primarily standardizing formatting and refreshing rule guidance/examples.
Changes:
- Normalizes markdown formatting (example style, link-reference spacing) across many rule pages.
- Reorganizes/expands some rule content (for example, parameter sections and additional explanatory examples).
- Updates select rule text/examples to match upstream—though a few updates introduce doc issues that should be corrected before merge.
Reviewed changes
Copilot reviewed 28 out of 29 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md | Updates applicability note for workflows/InlineScript (currently introduces an incorrect PS version statement). |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConstrainedLanguageMode.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md | Minor wording tweak + removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md | Updates front-matter description and reformats a sample (front-matter change needs correction). |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md | Reformats function examples and cleans link-reference spacing. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md | Aligns hashtable formatting in an example. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingAllowUnencryptedAuthentication.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md | Minor wording/formatting tweak + removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidReservedWordsAsFunctionNames.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md | Adds punctuation to front-matter description + cleans link-reference spacing. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md | Adds punctuation to front-matter description + cleans link-reference spacing. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md | Removes stray whitespace before link references. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md | Adds punctuation to front-matter description and removes a version-availability note. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidExclaimOperator.md | Reorders/clarifies “Parameters” vs “Configure rule” section content. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md | Adds a “begin” block to compliant example (currently redundant/misleading). |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md | Adds TODO block and a “How” section (TODO should not ship in published docs). |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md | Adds additional explanatory examples for alignment-related parameters. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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 34d7d82: ✅ Validation status: passed
This comment lists only the first 25 files in the pull request. |
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 docs changes with source repo
PR Checklist