docs: update Claude docs from PR review analysis#394
Merged
ninja-shreyash merged 1 commit intomainfrom Apr 27, 2026
Merged
Conversation
…04-27) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
ninja-shreyash
approved these changes
Apr 27, 2026
Raina451
approved these changes
Apr 27, 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-04-20 -> 2026-04-27).
Analyzed 7 PRs with 56 resolved/effectively-resolved review threads. Found 3 actionable insights.
Changes
agent_docs/rules.mdawait service.method()notconst result = await service.method()forPromise<void>methods. Assigning void implies the return is usable, misleading users.Source: PR feat(jobs): add Jobs.stop() method [PLT-100574] #337 — reviewer noted that
const result = await jobs.stop(...)in JSDoc examples was misleading sincestop()returnsPromise<void>.agent_docs/conventions.mdPromise.all— when a method makes multiple independent API calls (e.g., chunk-based key resolution), usePromise.allinstead of sequential calls to avoid compounding latency.Source: PR feat(jobs): add Jobs.stop() method [PLT-100574] #337 — reviewer noted that chunk fetches were independent and should be parallelized.
Agents.mdSource: PR feat(conversations): expose disconnect method for clean process exit #340 — reviewer said "Let's not bump up the version with this change. We might have a few other changes we want to ship with the next version. We'll raise a separate PR for the version change."
No changes
CLAUDE.md— no relevant insights foundagent_docs/architecture.md— no relevant insights foundPRs Analyzed