Skip to content

docs(natspec): correct LibOpContext.run/@param: column is low byte, row is second byte#538

Open
thedavidmeister wants to merge 1 commit into
mainfrom
2026-06-30-issue-2671-libopcontext-param
Open

docs(natspec): correct LibOpContext.run/@param: column is low byte, row is second byte#538
thedavidmeister wants to merge 1 commit into
mainfrom
2026-06-30-issue-2671-libopcontext-param

Conversation

@thedavidmeister

Copy link
Copy Markdown
Contributor

Summary

Corrects the @param operand NatSpec in LibOpContext.run and LibOpContext.referenceFn.

LibSubParse.subParserContext (the encoder) stores column at offset 0x23 (low byte) and row at offset 0x22 (second byte). The old NatSpec said the opposite — "row (low byte) and column (second byte)" — inverting the semantics in documentation.

The actual cell read state.context[i][j] where i = low byte, j = second byte is always consistent with the encode side, so no runtime behavior is affected. This is a doc-only fix.

Refs rainlanguage/raindex#2671 (item 5 — @param column/row inversion in LibOpContext.run/referenceFn)

Test plan

  • CI passes (NatSpec-only change, no Solidity logic change)
  • Slither passes

…e, row is second byte

LibSubParse.subParserContext (line 68-69) stores column at low byte 0x23
and row at second byte 0x22. LibOpContext.run/referenceFn said the opposite
('row (low byte) and column (second byte)'), inverting the semantics. The
actual cell read is always correct (encode/decode use the same byte), but
the @param description was misleading.

Refs rainlanguage/raindex#2671 (item 5 — @param column/row inversion).
@thedavidmeister thedavidmeister self-assigned this Jun 30, 2026
@coderabbitai

coderabbitai Bot commented Jun 30, 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: 45 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: 1189bb4e-f27a-43c1-af31-4c589eab6a31

📥 Commits

Reviewing files that changed from the base of the PR and between b3d5081 and 2a860b9.

📒 Files selected for processing (1)
  • src/lib/op/00/LibOpContext.sol
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-06-30-issue-2671-libopcontext-param

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