Skip to content

fix: correct NatSpec documentation errors#6421

Open
Fallengirl wants to merge 2 commits intoOpenZeppelin:masterfrom
Fallengirl:fix/natspec-docs
Open

fix: correct NatSpec documentation errors#6421
Fallengirl wants to merge 2 commits intoOpenZeppelin:masterfrom
Fallengirl:fix/natspec-docs

Conversation

@Fallengirl
Copy link
Contributor

  1. Arrays.sol: upperBound comment said "strictly less than" but should be "less than or equal to" - the function returns array length when all elements are <= element, not just < element.
  2. AccessManager.sol: comment referenced non-existent {executed} function, should be {execute}.

@Fallengirl Fallengirl requested a review from a team as a code owner March 20, 2026 07:00
@changeset-bot
Copy link

changeset-bot bot commented Mar 20, 2026

⚠️ No Changeset found

Latest commit: 0cbcf8c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: f764589f-d93e-4c65-9f27-580b6c6d8a90

📥 Commits

Reviewing files that changed from the base of the PR and between 45f032d and 0cbcf8c.

📒 Files selected for processing (2)
  • contracts/access/manager/AccessManager.sol
  • contracts/utils/Arrays.sol

Walkthrough

This pull request updates NatSpec documentation comments in two contracts. In AccessManager.sol, the _isExecuting helper's documentation is corrected to reference "{execute}" instead of "{executed}". In Arrays.sol, the upperBound function's NatSpec is updated to clarify the termination condition as "less than or equal to element" instead of "strictly less than element". Both changes are documentation-only with no modifications to function implementations, logic, or behavior.

Suggested labels

typo

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately summarizes the main change: correcting NatSpec documentation errors across two files.
Description check ✅ Passed The description is directly related to the changeset, providing specific details about which NatSpec comments were fixed and why.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

You can enable review details to help with troubleshooting, context usage and more.

Enable the reviews.review_details setting to include review details such as the model used, the time taken for each step and more in the review comments.

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