Align to style and minor spelling - 7.7 folder#13059
Open
ArieHein wants to merge 1 commit into
Open
Conversation
Contributor
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
Note
Copilot was unable to run its full agentic suite in this review.
This PR standardizes PowerShell reference markdown formatting by reflowing long lines (especially SYNTAX blocks), improving readability, and converting some inline command examples into fenced code blocks.
Changes:
- Rewrapped long SYNTAX declarations across many cmdlet reference pages to consistent line lengths/indentation.
- Reflowed paragraphs and split long “CommonParameters” sentences for readability.
- Converted select inline command examples into fenced
powershellcode blocks and removed a few stray blank lines.
Reviewed changes
Copilot reviewed 160 out of 160 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| reference/7.7/PSReadLine/Set-PSReadLineOption.md | Rewrapped SYNTAX block lines for readability |
| reference/7.7/PSReadLine/Get-PSReadLineKeyHandler.md | Split CommonParameters link onto a new line |
| reference/7.7/PSReadLine/About/about_PSReadLine_Functions.md | Reflowed long list line for consistent wrapping |
| reference/7.7/PSReadLine/About/about_PSReadLine.md | Reflowed paragraph line breaks |
| reference/7.7/PSDiagnostics/Start-Trace.md | Rewrapped SYNTAX block lines |
| reference/7.7/Microsoft.WSMan.Management/Test-WSMan.md | Rewrapped SYNTAX block lines |
| reference/7.7/Microsoft.WSMan.Management/Set-WSManQuickConfig.md | Split CommonParameters link onto a new line |
| reference/7.7/Microsoft.WSMan.Management/Set-WSManInstance.md | Rewrapped SYNTAX blocks; converted inline example to fenced powershell block |
| reference/7.7/Microsoft.WSMan.Management/Remove-WSManInstance.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.WSMan.Management/New-WSManSessionOption.md | Rewrapped SYNTAX; split CommonParameters link onto a new line |
| reference/7.7/Microsoft.WSMan.Management/New-WSManInstance.md | Rewrapped SYNTAX; reflowed paragraphs; converted inline example to fenced block |
| reference/7.7/Microsoft.WSMan.Management/Invoke-WSManAction.md | Rewrapped SYNTAX; reflowed paragraphs; converted inline example to fenced block; split CommonParameters link |
| reference/7.7/Microsoft.WSMan.Management/Get-WSManInstance.md | Rewrapped SYNTAX blocks; split CommonParameters link |
| reference/7.7/Microsoft.WSMan.Management/Enable-WSManCredSSP.md | Rewrapped SYNTAX; split CommonParameters link |
| reference/7.7/Microsoft.WSMan.Management/Disconnect-WSMan.md | Split CommonParameters link onto a new line |
| reference/7.7/Microsoft.WSMan.Management/Connect-WSMan.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.WSMan.Management/About/about_WSMan_Provider.md | Reflowed paragraphs and list items |
| reference/7.7/Microsoft.PowerShell.Utility/Write-Information.md | Removed stray blank line under SYNOPSIS header |
| reference/7.7/Microsoft.PowerShell.Utility/Write-Host.md | Removed stray blank line; rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Write-Error.md | Split link sentence onto a new line |
| reference/7.7/Microsoft.PowerShell.Utility/Wait-Event.md | Reflowed long example descriptions |
| reference/7.7/Microsoft.PowerShell.Utility/Update-TypeData.md | Rewrapped SYNTAX; reflowed parameter descriptions |
| reference/7.7/Microsoft.PowerShell.Utility/Update-List.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Update-FormatData.md | Rewrapped SYNTAX; reflowed paragraphs; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/Unregister-Event.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Unblock-File.md | Minor markup tweak and reflow |
| reference/7.7/Microsoft.PowerShell.Utility/Trace-Command.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Tee-Object.md | Rewrapped SYNTAX; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/Show-Markdown.md | Split CommonParameters link onto a new line |
| reference/7.7/Microsoft.PowerShell.Utility/Show-Command.md | Reflowed paragraph; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/Set-Variable.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Set-TraceSource.md | Rewrapped SYNTAX; added powershell fence to example; reflowed CommonParameters |
| reference/7.7/Microsoft.PowerShell.Utility/Set-PSBreakpoint.md | Rewrapped SYNTAX; reflowed related links; added spacing before parameter section content |
| reference/7.7/Microsoft.PowerShell.Utility/Set-MarkdownOption.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Set-Date.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Set-Alias.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Send-MailMessage.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Select-Xml.md | Rewrapped SYNTAX blocks; reflowed example explanation |
| reference/7.7/Microsoft.PowerShell.Utility/Select-String.md | Rewrapped multiple SYNTAX blocks; reflowed parameter description |
| reference/7.7/Microsoft.PowerShell.Utility/Select-Object.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Remove-Variable.md | Rewrapped SYNTAX; split links/CommonParameters |
| reference/7.7/Microsoft.PowerShell.Utility/Remove-TypeData.md | Split link sentence onto a new line |
| reference/7.7/Microsoft.PowerShell.Utility/Remove-PSBreakpoint.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Register-ObjectEvent.md | Rewrapped SYNTAX; reflowed paragraphs; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/Out-GridView.md | Reflowed numbered/bulleted instructions |
| reference/7.7/Microsoft.PowerShell.Utility/Out-File.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/New-Variable.md | Rewrapped SYNTAX; reflowed CommonParameters |
| reference/7.7/Microsoft.PowerShell.Utility/New-TemporaryFile.md | Reflowed paragraph; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/New-Object.md | Rewrapped SYNTAX; reflowed example text; converted inline example to fenced block; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/New-Event.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/New-Alias.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Measure-Object.md | Rewrapped SYNTAX; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/Join-String.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md | Rewrapped large SYNTAX blocks; converted inline example to fenced block |
| reference/7.7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md | Rewrapped large SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Import-PSSession.md | Rewrapped SYNTAX; reflowed paragraphs; split link sentence |
| reference/7.7/Microsoft.PowerShell.Utility/Import-LocalizedData.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Import-Csv.md | Removed stray blank line; rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Import-Clixml.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Import-Alias.md | Rewrapped SYNTAX; reflowed security note; converted inline example to fenced block; reflowed CommonParameters |
| reference/7.7/Microsoft.PowerShell.Utility/Get-Variable.md | Rewrapped SYNTAX; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/Get-TypeData.md | Reflowed paragraph lines |
| reference/7.7/Microsoft.PowerShell.Utility/Get-TraceSource.md | Split CommonParameters link onto a new line |
| reference/7.7/Microsoft.PowerShell.Utility/Get-SecureRandom.md | Rewrapped SYNTAX; reflowed paragraph lines |
| reference/7.7/Microsoft.PowerShell.Utility/Get-RunspaceDebug.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Get-Random.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Get-PSBreakpoint.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Get-Host.md | Split link sentence onto a new line |
| reference/7.7/Microsoft.PowerShell.Utility/Get-FormatData.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Get-Error.md | Removed stray blank line; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/Get-Date.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Get-Alias.md | Rewrapped SYNTAX; reflowed scope note; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/Format-Wide.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Format-Table.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Format-List.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Format-Hex.md | Removed stray blank line; rewrapped SYNTAX; split links/CommonParameters |
| reference/7.7/Microsoft.PowerShell.Utility/Format-Custom.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Export-PSSession.md | Removed stray blank line; rewrapped SYNTAX; reflowed bullet item |
| reference/7.7/Microsoft.PowerShell.Utility/Export-FormatData.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Export-Csv.md | Removed stray blank line; rewrapped SYNTAX; reflowed example explanations |
| reference/7.7/Microsoft.PowerShell.Utility/Export-Clixml.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Export-Alias.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/Enable-RunspaceDebug.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Enable-PSBreakpoint.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Disable-RunspaceDebug.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Disable-PSBreakpoint.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Debug-Runspace.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/ConvertTo-Xml.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/ConvertTo-Json.md | Reflowed parameter description lines |
| reference/7.7/Microsoft.PowerShell.Utility/ConvertTo-Html.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Utility/ConvertTo-Csv.md | Removed stray blank line; rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/ConvertFrom-SddlString.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/ConvertFrom-Markdown.md | Split CommonParameters link onto a new line |
| reference/7.7/Microsoft.PowerShell.Utility/ConvertFrom-Json.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/ConvertFrom-Csv.md | Removed stray blank line; rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Utility/Clear-Variable.md | Rewrapped SYNTAX; reflowed scope note; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Utility/Add-Type.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.ThreadJob/Start-ThreadJob.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Security/Unprotect-CmsMessage.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Security/Test-FileCatalog.md | Rewrapped SYNTAX; reflowed CommonParameters |
| reference/7.7/Microsoft.PowerShell.Security/Set-ExecutionPolicy.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Security/Set-Acl.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Security/Protect-CmsMessage.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Security/Get-PfxCertificate.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Security/Get-ExecutionPolicy.md | Split link sentence onto a new line |
| reference/7.7/Microsoft.PowerShell.Security/Get-Credential.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Security/Get-AuthenticodeSignature.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Security/ConvertTo-SecureString.md | Rewrapped SYNTAX; reflowed example description text |
| reference/7.7/Microsoft.PowerShell.Security/ConvertFrom-SecureString.md | Rewrapped multiple SYNTAX blocks; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Management/Test-Path.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Test-Connection.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Suspend-Service.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Stop-Service.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Stop-Process.md | Rewrapped SYNTAX; split CommonParameters link |
| reference/7.7/Microsoft.PowerShell.Management/Start-Service.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Start-Process.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Split-Path.md | Rewrapped SYNTAX blocks; reflowed parameter description |
| reference/7.7/Microsoft.PowerShell.Management/Set-TimeZone.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Management/Set-Service.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Set-ItemProperty.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Set-Item.md | Rewrapped multiple SYNTAX blocks; reflowed paragraphs/links |
| reference/7.7/Microsoft.PowerShell.Management/Set-Content.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Resume-Service.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Restart-Service.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Restart-Computer.md | Rewrapped SYNTAX; removed duplicate EXAMPLES header |
| reference/7.7/Microsoft.PowerShell.Management/Rename-ItemProperty.md | Rewrapped SYNTAX; reflowed filter/link paragraphs |
| reference/7.7/Microsoft.PowerShell.Management/Rename-Item.md | Rewrapped SYNTAX; reflowed example description |
| reference/7.7/Microsoft.PowerShell.Management/Rename-Computer.md | Rewrapped SYNTAX; split link sentence |
| reference/7.7/Microsoft.PowerShell.Management/Remove-Service.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Management/Remove-PSDrive.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Management/Remove-ItemProperty.md | Rewrapped SYNTAX; reflowed filter/link paragraphs |
| reference/7.7/Microsoft.PowerShell.Management/Remove-Item.md | Rewrapped multiple SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Push-Location.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Management/New-Service.md | Rewrapped SYNTAX; edited example heading punctuation |
| reference/7.7/Microsoft.PowerShell.Management/New-PSDrive.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Management/New-ItemProperty.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/New-Item.md | Rewrapped multiple SYNTAX blocks; split link sentence |
| reference/7.7/Microsoft.PowerShell.Management/Move-ItemProperty.md | Rewrapped SYNTAX; reflowed filter/link paragraphs |
| reference/7.7/Microsoft.PowerShell.Management/Move-Item.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Join-Path.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Management/Invoke-Item.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Get-Service.md | Rewrapped SYNTAX blocks; reflowed paragraphs |
| reference/7.7/Microsoft.PowerShell.Management/Get-PSDrive.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Get-ItemPropertyValue.md | Rewrapped SYNTAX; adjusted example formatting; reflowed filter/link paragraphs |
| reference/7.7/Microsoft.PowerShell.Management/Get-ItemProperty.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Management/Get-Item.md | Split link sentence onto a new line |
| reference/7.7/Microsoft.PowerShell.Management/Get-HotFix.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Management/Get-Content.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Management/Copy-ItemProperty.md | Rewrapped SYNTAX; reflowed filter/link paragraphs |
| reference/7.7/Microsoft.PowerShell.Management/Clear-RecycleBin.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Management/Clear-ItemProperty.md | Rewrapped SYNTAX; reflowed filter/link paragraphs |
| reference/7.7/Microsoft.PowerShell.Management/Clear-Item.md | Rewrapped SYNTAX; split link sentence |
| reference/7.7/Microsoft.PowerShell.Management/Add-Content.md | Rewrapped SYNTAX blocks |
| reference/7.7/Microsoft.PowerShell.Host/Start-Transcript.md | Rewrapped SYNTAX blocks and reflowed example description |
| reference/7.7/Microsoft.PowerShell.Diagnostics/New-WinEvent.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Diagnostics/Get-WinEvent.md | Rewrapped SYNTAX blocks; reflowed example explanations; split link sentence |
| reference/7.7/Microsoft.PowerShell.Diagnostics/Get-Counter.md | Rewrapped SYNTAX block |
| reference/7.7/Microsoft.PowerShell.Core/Where-Object.md | Reflowed list item wrapping; corrected “simiplified” -> “simplified” |
| reference/7.7/CimCmdlets/Register-CimIndicationEvent.md | Removed trailing blank line at end of file |
| reference/7.7/CimCmdlets/CimCmdlets.md | Removed trailing blank line at end of file |
Comments suppressed due to low confidence (3)
reference/7.7/Microsoft.PowerShell.Utility/Out-GridView.md:1
- The ordered list numbering was changed so every step is
1., which breaks the step sequence and makes the instructions harder to follow. Restore sequential numbering (1, 2, 3, …) for these steps (or use consistent Markdown auto-numbering intentionally, but keep the source consistent with the rest of the doc).
reference/7.7/Microsoft.PowerShell.Utility/Unblock-File.md:1 - Grammar issue: the sentence is missing a word ("cmdlet to get files"). Consider updating to '... parameter of the
Get-Itemcmdlet to get files with the Zone.Identifier stream.'
reference/7.7/Microsoft.PowerShell.Utility/Get-TypeData.md:1 - The .NET type name appears to be incorrect:
System.DataTimeshould beSystem.DateTime.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+179
to
+180
| For more information, se | ||
| [about_Quoting_Rules](../Microsoft.Powershell.Core/About/about_Quoting_Rules.md). |
Contributor
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
Aligning to style - specifically removing empty lines under SYNOPSIS due to publishing requirements
- line size limitations
- one minor spelling fix
PR Checklist