docs: fix stale cursor doc in NatSpec (#128)#141
Conversation
- ICorporateActionsV1.getActionParameters: NatSpec described the input as "a cursor returned from one of the traversal getters" — but the return crosses the API boundary as data, so it's an actionId per the rename convention. Updated to actionId; same fix on the "mask the cursor's actionType" line below. - LibCorporateActionReceipt.accountIdCursor: comment claimed "1-based index" with "0 = never migrated". Stale post-PR-124: indexing is 0-based and `cursor == 0` is the bootstrap node (identity for splits), semantically "no real migration applied yet". Comment now matches. Doc-only — no code changes, no bytecode impact. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ 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. Review rate limit: 0/1 reviews remaining, refill in 20 minutes and 27 seconds.Comment |
Summary
Doc-only fixups found while auditing remaining cursor uses after #139 / #140.
Fixes:
No code changes, no bytecode impact.
After this lands, #128 can close — every remaining `cursor` reference in src/ is either a storage variable holding state-machine progress over time, a local variable during a walk, or descriptive prose about the cursor concept. All legitimate per the convention documented in the interface NatSpec.
Test plan
🤖 Generated with Claude Code