Skip to content

Make the comment rule's test explicit: delete, don't shorten #358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sibson merged 1 commit into from
Aug 17, 2026
Merged

Make the comment rule's test explicit: delete, don't shorten #358

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ longer block needs a reason to be longer. Do not restate what the next line
does, and do not narrate what a change replaced -- that belongs in the
commit message. Design rationale belongs in `docs/`.

Test each one by deleting it and asking what the reader lost. Being able
to justify a comment is not the same as needing it: shortening an
unnecessary comment leaves an unnecessary comment.

A cross-reference is worth a clause when it saves the reader real work
(`see docs/capture.rst`), so an explanation lives in exactly one place
rather than being repeated. What it must not become is a paragraph
Expand Down
Loading