Skip to content

docs(sflr): add @return and clarify sFLR-per-FLR rate direction in run() NatSpec#195

Open
thedavidmeister wants to merge 1 commit into
mainfrom
2026-06-30-issue-94-sflr-run-natspec
Open

docs(sflr): add @return and clarify sFLR-per-FLR rate direction in run() NatSpec#195
thedavidmeister wants to merge 1 commit into
mainfrom
2026-06-30-issue-94-sflr-run-natspec

Conversation

@thedavidmeister

Copy link
Copy Markdown
Collaborator

Closes #94

Summary

LibOpSFlrCurrentExchangeRate.run() had no @return NatSpec and the existing description "FLR to sFLR" was ambiguous about direction.

Changes:

  • Adds @return documenting that the output is the sFLR-per-FLR exchange rate as an 18-decimal Float.
  • Rewrites the run() doc comment to state the direction unambiguously: the number of sFLR received per FLR deposited (typically < 1.0 because sFLR accrues value relative to FLR over time).
  • Fixes integrity() comment: "SFLR" → "sFLR" for consistency and clarifies 0-inputs/1-output.

🤖 Generated with Claude Code

…n() NatSpec

Closes #94

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@thedavidmeister thedavidmeister self-assigned this Jun 30, 2026
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 41 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 17278c48-a5a7-4b84-add4-909e2e44452c

📥 Commits

Reviewing files that changed from the base of the PR and between cb20d03 and 4e65801.

📒 Files selected for processing (1)
  • src/lib/op/LibOpSFlrCurrentExchangeRate.sol
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-06-30-issue-94-sflr-run-natspec

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.

[F43] [LOW] run() NatSpec omits @return and the rate direction is ambiguous/inconsistent

1 participant