Skip to content

docs(did): fix createDidPkhUri JSDoc argument order - #209

Merged
venables merged 1 commit into
agentcommercekit:mainfrom
kutluhaneth46:cursor/docs-did-pkh-jsdoc-args-88c1
Sep 9, 2026
Merged

venables merged 1 commit into
agentcommercekit:mainfrom
kutluhaneth46:cursor/docs-did-pkh-jsdoc-args-88c1

Conversation

@kutluhaneth46

@kutluhaneth46 kutluhaneth46 commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Align createDidPkhUri JSDoc @param order and examples with the real (chainId, address) signature.
  • Use a full Solana CAIP-2 chain ID in the example instead of bare solana.

Testing

  • Docs-only change; compared against packages/did/README.md and existing call sites.

AI usage disclosure

Assisted by Cursor. I confirmed the signature/docs mismatch against README and runtime call sites before submitting.

Fixes #206

Summary by CodeRabbit

  • Documentation
    • Updated createDidPkhUri documentation to reflect the correct parameter order.
    • Clarified examples to use complete CAIP-2 chain identifiers.

Align @PARAM tags and examples with the real (chainId, address)
signature, and use a full Solana CAIP-2 chain ID in the example.

Fixes agentcommercekit#206
@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: 88f0a712-e725-4f13-8fe0-316dccbf0eea

📥 Commits

Reviewing files that changed from the base of the PR and between 7d23f83 and 2bd6663.

📒 Files selected for processing (1)
  • packages/did/src/methods/did-pkh.ts

Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review.


Walkthrough

Changes

DID PKH documentation

Layer / File(s) Summary
Align createDidPkhUri JSDoc
packages/did/src/methods/did-pkh.ts
The JSDoc lists chainId before address. Examples now use the full CAIP-2 chain ID and the correct argument order.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 2bd66

Documentation now shows createDidPkhUri with chainId before address and valid CAIP-2 examples. No production behavior changes are introduced, and no merge-blocking risk remains.

Suggested reviewers: venables

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change and the corrected argument order for createDidPkhUri.
Linked Issues check ✅ Passed The change satisfies issue #206. It corrects the JSDoc parameter order, updates examples to use (chainId, address), and replaces the bare solana value with a full CAIP-2 chain ID.
Out of Scope Changes check ✅ Passed The changes are limited to the targeted JSDoc in packages/did/src/methods/did-pkh.ts. No unrelated runtime or file changes are reported.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@venables venables left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the correction; verified against the signature and the demo call sites.

@venables
venables merged commit d5f8d72 into agentcommercekit:main Sep 9, 2026
2 checks passed
@kutluhaneth46

Copy link
Copy Markdown
Contributor Author

Thanks for the review and merge, @venables.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(did): createDidPkhUri JSDoc swaps argument order and uses invalid Solana CAIP-2

2 participants