Docs: Add Javadoc guidance to AGENTS.md#16764
Merged
Merged
Conversation
Capture rdblue's instruction from PR apache#16689: Javadoc should describe a class or method's purpose as if it were defined by an interface, not restate or leak implementation details that create churn when the implementation changes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
anoopj
approved these changes
Jun 10, 2026
amogh-jahagirdar
approved these changes
Jun 11, 2026
Contributor
|
Thanks @stevenzwu and @anoopj for reviewing |
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
3 participants
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.
Summary
AGENTS.mdcapturing @rdblue's Javadoc instruction from Core: Add EntryStatus.MODIFIED and TrackingBuilder status derivation #16689: describe purpose, not implementation; document the component as if it were defined by an interface; don't leak implementation details.Test plan
🤖 Generated with Claude Code