Add container/member doc-comment guideline to AGENTS.md - #15285
Merged
Conversation
Contributor
Author
|
This PR was generated with Warp. Comment |
acarl005
approved these changes
Aug 18, 2026
acarl005
marked this pull request as ready for review
August 18, 2026 22:07
acarl005
enabled auto-merge (squash)
August 18, 2026 22:08
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.


Description
Adds a new guideline to the Comments section of
AGENTS.md, based on feedback from a Slack thread: an agent had added a struct-level doc comment that enumerated and explained several of the struct's fields, while those same fields also carried their own doc comments repeating the same explanation (seeapp/src/terminal/event.rsin PR #15162, theUserBlockCompletedstruct).The new bullet,
**Container docs describe the whole, member docs describe the parts**, states that a member's own doc comment is where that member gets explained, and a container's item-level doc comment must not enumerate or re-explain its members. It generalizes the existing**Single-source of documentation**bullet to the container/member relationship, and is placed directly after it to keep related guidance together.This is a docs-only change to
AGENTS.md; no other files are touched.Testing
This is a Markdown documentation change with no executable code, so no automated or manual testing applies. I confirmed the new bullet's lines stay within the section's documented ~100-column wrap, consistent with the surrounding bullets.
./script/runAgent Mode