Sync rules docs from docs repo #2144
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
andyleejordan
approved these changes
Dec 3, 2025
andyleejordan
approved these changes
Dec 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Sync rules docs from docs repo