Skip to content

docs(natspec): correct stale calculateClearStateChange description#2789

Open
thedavidmeister wants to merge 3 commits into
mainfrom
2026-06-26-issue-2671-natspec-clear
Open

docs(natspec): correct stale calculateClearStateChange description#2789
thedavidmeister wants to merge 3 commits into
mainfrom
2026-06-26-issue-2671-natspec-clear

Conversation

@thedavidmeister

Copy link
Copy Markdown
Contributor

Summary

Corrects the calculateClearStateChange function-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's outputMax and back-calculates the output as input / IORatio.

No logic or bytecode change; doc-only.

Refs #2671 (item 4 — stale calculateClearStateChange NatSpec).

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
@thedavidmeister thedavidmeister self-assigned this Jun 26, 2026
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@thedavidmeister, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 51 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 reviews.

How do review 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 refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1fb841da-7e21-4024-a20e-b425698f9957

📥 Commits

Reviewing files that changed from the base of the PR and between 8e382f8 and cd480b8.

📒 Files selected for processing (1)
  • src/concrete/raindex/RaindexV6.sol
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-06-26-issue-2671-natspec-clear

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.

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.

1 participant