feat(agent): flag excessive comments in code review, bump v1.46.0 - #8
Merged
Merged
Conversation
rust-code-reviewer now checks that in-code comments are reserved for genuinely complex blocks and never restate the code, while keeping public API doc comments mandatory regardless of complexity.
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
1 participant
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.
Summary
rust-code-reviewernow flags excessive/redundant in-code comments as aSUGGESTIONfinding: comments are only warranted for blocks with genuine cyclomatic/cognitive complexity (non-obvious branch, workaround, subtle invariant), never for restating straightforward code.///) remain mandatory regardless of complexity - the Documentation checklist and newComment Hygieneexample section spell this out explicitly.Test plan
rust-code/agents/06-rust-code-reviewer.mdfor consistency with existing checklist styleplugin.json/marketplace.jsonversions match (1.46.0)CHANGELOG.mdentry added under 1.46.0