docs(natspec): correct stale calculateClearStateChange description#2789
docs(natspec): correct stale calculateClearStateChange description#2789thedavidmeister wants to merge 1 commit into
Conversation
The old prose described the counterparty cap as "counterparty IO × max output" which was inherited verbatim from the legacy OrderBook. The actual cap formula (from calculateClearStateAlice) caps each order's input at the counterparty's `outputMax` and back-calculates the output as `input / IORatio`. Refs #2671
|
Warning Review limit reached
More reviews will be available in 36 minutes and 49 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ 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
Corrects the
calculateClearStateChangefunction-level NatSpec inherited verbatim from the legacy OrderBook. The old prose described the output cap as "counterparty IO × max output", but the actual formula (calculateClearStateAlice) caps each order's input at the counterparty'soutputMaxand back-calculates the output asinput / IORatio.No logic or bytecode change; doc-only.
Refs #2671 (item 4 — stale
calculateClearStateChangeNatSpec).