Skip to content

code health: drop the header-comment contract - #665

Merged
dayfine merged 1 commit into
agentsfrom
agents-header-comment-obvious
Nov 19, 2026
Merged

dayfine merged 1 commit into
agentsfrom
agents-header-comment-obvious

Conversation

@dayfine

@dayfine dayfine commented Nov 19, 2026

Copy link
Copy Markdown
Owner

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).

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
dayfine marked this pull request as ready for review November 19, 2026 05:13
@dayfine
dayfine merged commit 00a24c7 into agents Nov 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant