What problem does it solve?
Code comments and docstrings often narrate the change that produced them — what the code used to do, which alternatives were rejected, or that a fix was verified — which is invisible or misleading context for future readers who only see the code as it stands.
Core Features & Use Cases
- Scoped Diff Review: Reviews only added lines (
^\+) in comments, docstrings, and changelog content, with selectable scopes: staged changes, the full branch against the merge base, or a specific path.
- Narration Detection: Flags prose that describes old behavior, argues correctness, records verification, names rejected alternatives, or merely restates what the adjacent code already shows.
- Guided Remediation: Provides concrete rewrite examples and a remediation table covering amending commits, squashing, force-pushing, and editing PR descriptions depending on commit state.
- Use Case: Before opening a pull request, run the review on your branch to catch comments like "We used to buffer here, but that broke interruptions" and rewrite them to describe the code as it now stands.
Quick Start
Ask the assistant to run the prose review on the current branch to check that all added comments and docstrings document the code rather than narrate the change.
