Sync rules docs from docs repo by sdwheeler · Pull Request #2144 · PowerShell/PSScriptAnalyzer
Pull request overview
This PR syncs rules documentation from the docs repository to update formatting and improve clarity across three rule documentation files. The changes modernize markdown formatting conventions and refine language for better readability.
Key changes include:
- Standardization of heading levels (Parameters sections moved from level 4 to level 2)
- Conversion to reference-style links and modern markdown alert syntax
- Grammar and clarity improvements in rule descriptions
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/Rules/UseCorrectCasing.md | Updated heading levels for Parameters section and parameter names; improved operator example formatting with code blocks |
| docs/Rules/AvoidReservedWordsAsFunctionNames.md | Converted inline link to reference-style format; improved wording for clarity |
| docs/Rules/AvoidLongLines.md | Updated ms.date; converted note to markdown alert syntax; added backticks to parameter names in headings; contains a grammar error |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.