Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the README documentation for the expressionComplexity rule so the metrics table renders correctly in Markdown (notably around operators containing |).
Changes:
- Fixes Markdown table formatting for the
expressionComplexitymetrics list. - Escapes the
||operator in themaxBranchesrow to avoid breaking table column parsing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `maxDepth` | Maximum nesting depth | 8 | | ||
| | `maxCalls` | Contract method call nodes in the AST | 10 | | ||
| | `maxOperators` | Arithmetic, comparison, and membership operators | 15 | | ||
| | `maxBranches` | Ternary (`?:`) and logical (`&&`, `\|\| `) branching | 6 | |
There was a problem hiding this comment.
In the maxBranches description, the inline code for the logical OR operator has a trailing space (\|\| ). This is easy to miss and can lead to inconsistent rendering/formatting compared to other occurrences (e.g., a && b \|\| c below). Consider removing the trailing space so the token is represented consistently.
Suggested change
| | `maxBranches` | Ternary (`?:`) and logical (`&&`, `\|\| `) branching | 6 | | |
| | `maxBranches` | Ternary (`?:`) and logical (`&&`, `\|\|`) branching | 6 | |
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.
No description provided.