docs(api): drop @brief where it is the only description - #841
Merged
Conversation
andiwand
force-pushed
the
test/pin-enum-ordinals
branch
from
September 6, 2026 14:26
5316deb to
8ad4ad0
Compare
196 doc comments in the public headers opened with @brief and 174 of them had nothing under it, so the tag marked nothing off from anything - it read as ceremony rather than structure. 68 blocks already went without it, so the headers were inconsistent about it too, and there is no Doxyfile in the tree for the distinction to feed. The 22 that do carry a detail paragraph keep it, which is the line the rule added to AGENTS.md draws: write the description plainly, add @brief at the moment a second paragraph arrives. Paragraphs whose first line lost the seven characters are rewrapped, so the change adds no ragged wrapping. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012QiYawTVZyuMLQBQngdTeu
andiwand
force-pushed
the
docs/drop-redundant-brief
branch
from
September 6, 2026 14:34
ccea59a to
15c4301
Compare
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.
🤖 Generated with Claude Code
Stacked on #840 — the tip of the v7 series, so it applies cleanly. Docs
only; no signature moves.
The argument, and the numbers behind it
@briefmarks a short description off from a detailed one. Where there is nodetailed one, it marks nothing — it is ceremony in front of the only sentence
there is. Counting the public headers:
@briefwith nothing under it@briefwith a real detail paragraph@briefat allTwo things that count settles. The tag was never applied consistently — a
quarter of the blocks already went without it — and there is no
Doxyfileanywhere in the repo, so nothing is consuming the brief/detail distinction
today anyway.
The 19 that earn it keep it, and they all look like this:
AGENTS.mdgets the rule so it stays settled: write the description plainly;add
@briefat the moment a second paragraph arrives.Wrapping
Stripping seven characters off a first line leaves a multi-line paragraph
wrapped narrower than it needs to be, and
ReflowCommentsdoes notre-justify — it only breaks lines that overflow. So the ten affected paragraphs
are rewrapped by hand. Measured both ways: 32 paragraphs could pull a word up
before this change and 32 after, so it introduces no ragged wrapping.
Something the tag was hiding
With
@briefgone,filesystem.hppreads:14 comments are pure tautology — the declaration's own name restated:
/// Represents a documentonclass Document,/// Represents a text fileon
class TextFile, and so on.AGENTS.mdalready says "Don't restate thecode", so they arguably all want deleting.
I have not touched them here — that is a content change, not this one, and
deleting fourteen doc comments deserves its own review. They read no worse than
they did with the tag on. Say the word and it is a two-minute follow-up.
Verified
Full build clean, no new warnings; 113 targeted gtests pass. Nothing outside
comments changed — the diff is 186 tag removals plus the rewraps.