docs: update Claude docs from PR review analysis - #702
Open
claude[bot] wants to merge 2 commits into
Open
Conversation
…08-31) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
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-08-24 -> 2026-08-31).
Analyzed 10 PRs with 73 resolved/effectively-resolved threads. Found 4 actionable insights.
Changes
agent_docs/rules.md
Extend transform completeness rule to cover method overloads — when
getByIdhas multiple overloads (positional vs options-object form), each dispatch branch in the implementation has its own transform call, and a completeness test on the positional form does not exercise the options-object branch. Both branches need their own completeness test.Source: PR refactor(queues): fold WithMethods variants into getAll and getById [PLT-104203] #681 — reviewer
@swati354flagged that the options-formgetByIdoverload lacked a completeness check despite the positional form having one.Clarify polling-loop try-catch exception — the "NEVER wrap integration test calls in try/catch" rule now documents the narrow exception: polling loops that handle transient visibility errors may catch, but scope the catch to only the specific transient call. State-changing operations (e.g.,
retry(),cancel()) must be outside the catch so their failures propagate naturally.Source: PR test(maestro): reuse an existing faulted instance before seeding one for retry #688 — reviewer
@claudeidentified thatretry()was inside a catch scoped forgetByIdvisibility errors; aretry()failure would be swallowed andfaultRetriednever set.agent_docs/conventions.md
Interface synchronization on method signature changes — when a public method signature changes (new params, new overloads), the corresponding interface declaration (
IUiPath,{Entity}ServiceModel, etc.) must also be updated. An interface holding the old signature causes TypeScript errors at any call site holding an interface reference.Source: PR feat(auth): end the platform session on logout (OIDC RP-initiated logout) [PLT-107228] #636 — reviewer
@claudecaught thatIUiPathstill declaredlogout(): voidwhile the implementation was updated tologout(options?: LogoutOptions): void.Do NOT extend
FolderScopedOptionsfor services without OData —FolderScopedOptionsinheritsexpand/selectfromBaseOptions; extending it for services that don't accept OData params leaks those fields into query parameters and request bodies. Use a service-specific scoping type instead.Source: PR feat(integration-service): add folderId/folderPath scoping options [APPS-35792] #641 — PR author
@anil-uipathexplained why Integration Service needed its own scoping type.No changes
CLAUDE.md— no relevant insights foundAgents.md— no relevant insights foundagent_docs/architecture.md— no relevant insights foundPRs Analyzed