Skip to content

docs: update Claude docs from PR review analysis#394

Merged
ninja-shreyash merged 1 commit intomainfrom
claude-docs-update/2026-04-27
Apr 27, 2026
Merged

docs: update Claude docs from PR review analysis#394
ninja-shreyash merged 1 commit intomainfrom
claude-docs-update/2026-04-27

Conversation

@claude
Copy link
Copy Markdown
Contributor

@claude claude Bot commented Apr 27, 2026

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.md

  • Never assign a void return to a variable in JSDoc examplesawait service.method() not const result = await service.method() for Promise<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 since stop() returns Promise<void>.

agent_docs/conventions.md

  • Parallelize independent API calls with Promise.all — when a method makes multiple independent API calls (e.g., chunk-based key resolution), use Promise.all instead 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.md

  • Version bumps go in a separate PR — never include a version bump in a feature or fix PR. Other in-flight changes may need to ship in the same version.
    Source: 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 found
  • agent_docs/architecture.md — no relevant insights found

PRs Analyzed

PR Title Comments
#371 feat(jobs): add Jobs.resume method 19 threads
#380 docs: update Claude docs from PR review analysis 0 threads
#389 fix: skip download attachment tests due to API bug 0 threads
#340 feat(conversations): expose disconnect method for clean process exit 4 threads
#385 fix: pick user for task assignment 7 threads
#337 feat(jobs): add Jobs.stop() method 29 threads
#347 chore: remove CLI and codedapp-tool packages 1 thread

…04-27)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot requested a review from a team April 27, 2026 09:49
@claude claude Bot added the claude-docs-update Automated Claude docs enhancement label Apr 27, 2026
@claude claude Bot requested a review from ninja-shreyash April 27, 2026 09:49
@sonarqubecloud
Copy link
Copy Markdown

@ninja-shreyash ninja-shreyash merged commit 154b91f into main Apr 27, 2026
15 of 16 checks passed
@ninja-shreyash ninja-shreyash deleted the claude-docs-update/2026-04-27 branch April 27, 2026 11:21
@ninja-shreyash ninja-shreyash mentioned this pull request Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

claude-docs-update Automated Claude docs enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants