docs(sflr): add @return and clarify sFLR-per-FLR rate direction in run() NatSpec#195
docs(sflr): add @return and clarify sFLR-per-FLR rate direction in run() NatSpec#195thedavidmeister wants to merge 1 commit into
Conversation
…n() NatSpec Closes #94 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 41 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?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 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 configurationConfiguration used: Organization UI Review profile: ASSERTIVE 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 |
Closes #94
Summary
LibOpSFlrCurrentExchangeRate.run()had no@returnNatSpec and the existing description "FLR to sFLR" was ambiguous about direction.Changes:
@returndocumenting that the output is the sFLR-per-FLR exchange rate as an 18-decimal Float.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).integrity()comment: "SFLR" → "sFLR" for consistency and clarifies 0-inputs/1-output.🤖 Generated with Claude Code