Skip to content

docs: update Claude docs from PR review analysis#404

Merged
ninja-shreyash merged 1 commit intomainfrom
claude-docs-update/2026-05-04
May 5, 2026
Merged

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

Conversation

@claude
Copy link
Copy Markdown
Contributor

@claude claude Bot commented May 4, 2026

Summary

Weekly analysis of PR comments (2026-04-27 -> 2026-05-04).
Analyzed 17 PRs with comments from 10 reviewed in detail. Found 4 actionable insights.

Changes

agent_docs/rules.md

  • After a successful delete in an integration test, remove the resource from createdRecordIds
    Source: PR feat: add deleteRecordById method [PLT-95546] #338 — reviewer noted that after the delete test succeeded, the record was still in createdRecordIds, causing a spurious failure when cleanup ran and tried to delete an already-deleted record.

  • Consolidate service availability guards in beforeAll, not inline per test
    Source: PR Add Feedback service [PLT-92499] #184 — repeated if (!feedback) throw new Error(...) appeared in every it block instead of once in a shared beforeAll. Reviewer pushed back on the noise and duplication.

  • When a new option is added to one method, update related methods' @example blocks too
    Source: PR feat(cas): agent inputs in conversations #367agentInput was added to create() with a new example, but updateById() (which accepts the same option) was left without the example. Reviewer flagged it as effectively invisible to users.

agent_docs/conventions.md

  • Use direct return in bound method delegates, not await
    Source: PR feat: add deleteRecordById method [PLT-95546] #338 — reviewer asked "why await and not direct return?" on a bound method delegate. The await was adding an unnecessary microtask hop in factory functions that simply delegate to a service method.

No changes

  • CLAUDE.md — no relevant insights found
  • Agents.md — no relevant insights found
  • agent_docs/architecture.md — no relevant insights found

PRs Analyzed

PR Title Comments
#397 feat: rename coded action app sdk 0 threads
#400 chore: bump version to 1.3.4 0 threads
#362 feat: inject W3C traceparent header for request correlation 11 threads
#338 feat: add deleteRecordById method PLT-95546 17 threads
#398 fix: handle HTML error responses for invalid org/tenant 1 thread
#372 feat(jobs): add Jobs.restart method [PLT-102122] 18 threads
#393 fix(docs): escape angle brackets in coded-apps getting-started 0 threads
#367 feat(cas): agent inputs in conversations 4 threads
#395 chore(docs): update codedapps docs 0 threads
#396 1.3.3 0 threads
#184 Add Feedback service [PLT-92499] 60+ threads
#394 docs: update Claude docs from PR review analysis 0 threads
#382 fix: reset options.params to an empty object 2 threads
#371 feat(jobs): add Jobs.resume method [PLT-102121] 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
#391 chore(deps-dev): bump npm_and_yarn group 0 threads

…05-04)

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

sonarqubecloud Bot commented May 4, 2026

@ninja-shreyash ninja-shreyash merged commit 623ba34 into main May 5, 2026
17 of 18 checks passed
@ninja-shreyash ninja-shreyash deleted the claude-docs-update/2026-05-04 branch May 5, 2026 06:44
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