docs: update Claude docs from PR review analysis#559
Open
claude[bot] wants to merge 1 commit into
Open
Conversation
…06-29) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
ninja-shreyash
approved these changes
Jun 29, 2026
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.
Summary
Weekly analysis of PR comments (2026-06-22 -> 2026-06-29).
Analyzed 8 PRs with 77 review threads. Found 4 actionable insights.
Changes
agent_docs/conventions.md
Inline code comments must be concise — added a Code style rule noting that comments should express what is non-obvious in a short phrase, not restate the code or add multi-sentence commentary.
Source: PR fix: rewrite SDK field names in OData options for remaining services [PLT-106297] #548 — reviewer noted that Claude-generated inline comments were excessively verbose.
Timestamp field naming:
*Timesuffix only, never*At— added under Standard field renames. All timestamp fields in SDK response types must use*Time(e.g.,endedTime), not*At(e.g.,endedAt).Source: PR feat: allow to emit end exchange event from client for stopping response #510 — reviewer (copilot) flagged that new
Exchange.endedAtbroke consistency withcreatedTime/updatedTimeacross the entire SDK.agent_docs/rules.md
Never use unexplained abbreviations/acronyms in JSDoc — added to JSDoc quality rules. Spell out full forms; introduce abbreviated forms with the full name first.
Source: PR feat(agents): summary & distribution services (5/5) [PLT-103787] #535 — reviewer flagged undocumented acronyms
AGUandPLTUin JSDoc comments; author expanded them.Never use
@internalon individual fields of a public interface — added to JSDoc quality rules. TypeDoc omits the field from docs but TypeScript consumers still see it in IDE autocomplete.@internalbelongs only on whole declarations.Source: PR feat: allow to emit end exchange event from client for stopping response #510 — reviewer noted that
@internal endedAton a field in the publicExchangeinterface misleads consumers who still get IDE completion for it.No changes
CLAUDE.md— no relevant insights foundAgents.md— no relevant insights foundagent_docs/architecture.md— no relevant insights foundPRs Analyzed