pvary opened a new pull request, #18167: URL: https://github.com/apache/iceberg/pull/18167
Guidance lived in three Code Style bullets. The failure mode it targets: Javadoc that documents the implementation instead of the contract. This keeps recurring in review, so this PR gives it a section and a check that can be applied while writing: if a comment would need editing during a behavior-preserving refactor, it describes internals. One worked example contrasts the two. Not obvious from the diff: the rules are scoped to newly written code and say to leave existing comments alone, and api/ keeps brief @param and @return tags, matching the module's convention. --- **AI Disclosure** - Model: Claude Opus 5 - Platform/Tool: GitHub Copilot CLI - Human Oversight: Iteratated multiple times and Fully reviewed - Prompt Summary: Make Javadoc short and only added when it adds value, comments only when not deducible from the code, and Javadoc describe the goal of a method rather than its internals. Generated-by: GitHub Copilot CLI (Claude Opus 5) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
