Repository navigation
code health: drop the header-comment contract - #665
Merged
Merged
Conversation
Comments only when it's not obvious: a header symbol whose name says what it is needs no comment. AGENTS.md says the same. The advisory for a comment that describes the neighbouring function stays.
dayfine
marked this pull request as ready for review
November 19, 2026 05:13
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.
The header-comment check made every new namespace-scope header symbol carry a comment, so names that already say it all (CheckpointRunResult on #648) kept one-line comments that only restate the name. This removes the check, its README entry and tests, and changes AGENTS.md to comment only when it's not obvious; the advisory for a comment describing the neighbouring function stays. Code-health self-tests pass, and on autostory/shared-core deleting the CheckpointRunResult comment now passes (the old tool flagged that line).