Repository navigation
Update AlignAssignmentStatement rule docs with correct setting name - #2223
Open
Samuel D. Leslie (ralish) wants to merge 1 commit into
Open
Samuel D. Leslie (ralish) wants to merge 1 commit into
Samuel D. Leslie (ralish) wants to merge 1 commit into
Conversation
The documentation refers to the "CheckEnum" setting but the rule uses "CheckEnums" (plural).
Samuel D. Leslie (ralish)
requested review from
a team and
Mikey Lombardi (He/Him) (michaeltlombardi)
as code owners
October 7, 2026 01:39
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation now consistently matches the implemented setting name.
Review effort: Balanced
Findings: None
What changed in this PR
Corrects the documented enum-alignment setting to match the implemented CheckEnums property.
Changes:
- Updates the configuration example and parameter heading.
| File | Description |
|---|---|
docs/Rules/AlignAssignmentStatement.md |
Corrects CheckEnum to CheckEnums. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
|
Absolutely correct, this is my bad - thanks for spotting and fixing! |
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
The documentation refers to the
CheckEnumsetting but the rule usesCheckEnums(plural).PR Checklist
.cs,.ps1and.psm1files have the correct copyright headerWIP:to the beginning of the title and remove the prefix when the PR is ready.