Fix grammar and wording in NatSpec comments and tests#6355
Fix grammar and wording in NatSpec comments and tests#6355prestoalvarez wants to merge 3 commits intoOpenZeppelin:typo-fixesfrom
Conversation
|
WalkthroughThis PR contains documentation and comment improvements across two files. In Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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 | 🟠 MajorTemplate 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 generatedCheckpoints.solhas 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.jswith the same NatSpec corrections applied toCheckpoints.solto 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.
|
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.
|
Improve comparisons phrasing**: replace “greater/lower or equal than” with “greater/lower than or equal to”