docs(caip): fix createCaip10AccountId JSDoc argument order - #213
docs(caip): fix createCaip10AccountId JSDoc argument order#213kutluhaneth46 wants to merge 1 commit into
Conversation
Align @PARAM order with the real (chainId, address) signature and use a full Solana CAIP-2 chain ID instead of bare `solana`.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review. WalkthroughThe pull request updates the ChangesCAIP-10 documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This updates CAIP-10 helper documentation to accurately describe its existing chain ID and address arguments, with no runtime behavior or public API change. The documented examples match existing usage, so the change is ready to merge. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Summary
createCaip10AccountIdJSDoc@paramorder with the real(chainId, address)signature.solana.Same class of docs mismatch as the merged
createDidPkhUrifix (#209), but for CAIP-10. No existing open/closed PR covers this JSDoc.Testing
packages/caip/README.mdandcaip-10.test.tscall sites.AI usage disclosure
Assisted by Cursor. I confirmed the signature/docs mismatch against README and tests before submitting.
Summary by CodeRabbit
chainIdparameter documentation with complete CAIP-2 chain ID examples.