Skip to content

add @param tag to typed initialize overload#465

Open
thedavidmeister wants to merge 1 commit into
mainfrom
2026-05-07-issue-349-natspec-param-tags
Open

add @param tag to typed initialize overload#465
thedavidmeister wants to merge 1 commit into
mainfrom
2026-05-07-issue-349-natspec-param-tags

Conversation

@thedavidmeister

Copy link
Copy Markdown
Contributor

Summary

The unnamed initialize(EvaluableConfigV3[]) overload had a docstring describing the revert behaviour but no @param tag for its parameter. Named it evaluableConfigs and documented it as ABI-surface-only (the function reverts before reading it). The no-op self-reference quiets the unused-parameter warning.

The companion BadMinStackLength @param was already present on main — that part of the audit finding was stale.

Closes #349.

Test plan

  • build clean (NatSpec + parameter rename only)

🤖 Generated with Claude Code

The unnamed `initialize(EvaluableConfigV3[])` overload had a docstring
describing the revert behaviour but no @param tag for its parameter.
Named the parameter `evaluableConfigs` and documented it as
ABI-surface-only (the function reverts before reading it). The
no-op self-reference quiets the unused-parameter warning.

The companion BadMinStackLength @param was already present on main —
that part of the audit finding was stale.

Closes #349.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented May 7, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@thedavidmeister has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 53 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 351dc27f-a59a-45f6-ad30-5ee1baa8cb13

📥 Commits

Reviewing files that changed from the base of the PR and between ceaea3c and 7c309b2.

📒 Files selected for processing (1)
  • src/concrete/Flow.sol
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-05-07-issue-349-natspec-param-tags

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 and usage tips.

@thedavidmeister thedavidmeister self-assigned this May 9, 2026
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.

[A01-5] [INFO] BadMinStackLength and initialize overload missing @param tags

1 participant