Skip to content

Fix grammar and wording in NatSpec comments and tests#6355

Open
prestoalvarez wants to merge 3 commits intoOpenZeppelin:typo-fixesfrom
prestoalvarez:master
Open

Fix grammar and wording in NatSpec comments and tests#6355
prestoalvarez wants to merge 3 commits intoOpenZeppelin:typo-fixesfrom
prestoalvarez:master

Conversation

@prestoalvarez
Copy link
Contributor

Improve comparisons phrasing**: replace “greater/lower or equal than” with “greater/lower than or equal to”

@prestoalvarez prestoalvarez requested a review from a team as a code owner February 18, 2026 12:01
@changeset-bot
Copy link

changeset-bot bot commented Feb 18, 2026

⚠️ No Changeset found

Latest commit: 96254fa

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 Feb 18, 2026

Walkthrough

This PR contains documentation and comment improvements across two files. In contracts/utils/structs/Checkpoints.sol, multiple documentation comments are updated to standardize phrasing of boundary comparisons, replacing phrases like "greater or equal" with "greater than or equal" and similar variants. In test/access/manager/AccessManager.test.js, a test comment's grammar is corrected from "responsible of notifying" to "responsible for notifying". No functional code changes are included.

Suggested labels

typo

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: fixing grammar and wording in NatSpec comments and tests, which matches the changeset focused on documentation improvements.
Description check ✅ Passed The description is directly related to the changeset, providing specific details about replacing 'greater/lower or equal than' with 'greater/lower than or equal to' in comments.
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 docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
contracts/utils/structs/Checkpoints.sol (1)

3-3: ⚠️ Potential issue | 🟠 Major

Template file must be updated to match the generated changes.

The template file (scripts/generate/templates/Checkpoints.js) still contains the old, incorrect wording ("greater or equal than", "lower or equal than") while the generated Checkpoints.sol has been corrected to use proper phrasing ("greater than or equal to", "lower than or equal to"). Without updating the template with the same corrections, running the generation script again will silently overwrite all fixes in this PR.

Update scripts/generate/templates/Checkpoints.js with the same NatSpec corrections applied to Checkpoints.sol to ensure durability.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@contracts/utils/structs/Checkpoints.sol` at line 3, Update the generation
template Checkpoints.js so its NatSpec wording matches the corrected generated
file Checkpoints.sol: replace occurrences of "greater or equal than" with
"greater than or equal to" and "lower or equal than" with "lower than or equal
to" in the template so future runs of the generator preserve the corrected
phrasing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@contracts/utils/structs/Checkpoints.sol`:
- Line 3: Update the generation template Checkpoints.js so its NatSpec wording
matches the corrected generated file Checkpoints.sol: replace occurrences of
"greater or equal than" with "greater than or equal to" and "lower or equal
than" with "lower than or equal to" in the template so future runs of the
generator preserve the corrected phrasing.

@Amxx Amxx added this to the typo-fixes milestone Feb 26, 2026
@Amxx
Copy link
Collaborator

Amxx commented Feb 26, 2026

Template needs fixing.

@arr00 , you are a native english speaker, is that worth the change ?

@Amxx Amxx changed the base branch from master to typo-fixes February 26, 2026 13:16
@arr00
Copy link
Member

arr00 commented Feb 26, 2026

Template needs fixing.

@arr00 , you are a native english speaker, is that worth the change ?

I lean towards yes but we should also prefix key with an a.

Returns the value in the first (oldest) checkpoint with a key greater than or equal to the search key, or zero if

@Moses-main

This comment was marked as spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants