-
Notifications
You must be signed in to change notification settings - Fork 12.3k
Fix spelling issues #5948
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix spelling issues #5948
Conversation
|
WalkthroughThis PR updates documentation only. In docs/modules/ROOT/pages/eoa-delegation.adoc, it adds a bullet for “Implementing privilege de-escalation (e.g., sub-keys with limited permissions)” under batch operations, standardizes terminology (e.g., “delegate contracts,” collision wording), fixes grammar (e.g., “a smart contract,” “avoids replayability”), and adjusts wording around delegation flow, signing authorization, and Set Code usage without changing steps. In docs/modules/ROOT/pages/utilities.adoc, it corrects “compartor function” to “comparator function” in the Heap entry. No exported or public entities are altered. Possibly related PRs
Suggested labels
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/modules/ROOT/pages/eoa-delegation.adoc (2)
55-55: Grammar fix and improved clarity.The change from "ensure they require signatures that avoids replayability" to "ensure they require signatures that avoids replayability" corrects the subject-verb agreement. However, there appears to be a remaining grammatical issue.
The sentence should read "ensure they require signatures that avoid replayability" (plural verb "avoid" to agree with "signatures"):
-NOTE: When implementing delegate contracts, ensure they require signatures that avoids replayability (e.g. a domain separator, nonce). +NOTE: When implementing delegate contracts, ensure they require signatures that avoid replayability (e.g. a domain separator, nonce).
83-83: Sentence structure improvement needed.The sentence has structural issues that affect readability.
The sentence structure needs refinement for clarity:
-When changing an account's delegation, ensure the newly delegated code is purposely designed and tested as an upgrade to the old one. To ensure safe migration between delegate contracts, namespaced storage that avoids accidental collisions following ERC-7201. +When changing an account's delegation, ensure the newly delegated code is purposely designed and tested as an upgrade to the old one. To ensure safe migration between delegate contracts, use namespaced storage that avoids accidental collisions following ERC-7201.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/modules/ROOT/pages/eoa-delegation.adoc(3 hunks)docs/modules/ROOT/pages/utilities.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: tests-foundry
- GitHub Check: tests
- GitHub Check: tests-upgradeable
- GitHub Check: slither
- GitHub Check: coverage
- GitHub Check: halmos
🔇 Additional comments (3)
docs/modules/ROOT/pages/utilities.adoc (1)
266-266: LGTM - Typo corrected!The correction from "compartor function" to "comparator function" fixes a clear spelling error in the Heap documentation.
docs/modules/ROOT/pages/eoa-delegation.adoc (2)
3-3: Grammar improvement implemented.The change from "an smart contract" to "a smart contract" corrects the grammatical error - "smart" begins with a consonant sound, so it should use the article "a" rather than "an".
7-7: Good addition of privilege de-escalation concept.The new bullet point about "Implementing privilege de-escalation (e.g., sub-keys with limited permissions)" adds valuable documentation about an important security pattern in EOA delegation.
ernestognw
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Description
This PR corrects several minor typos in comments and documentation across the codebase. The changes are non-functional and purely textual to improve clarity and maintain a clean, professional codebase.
Details
an→aavoid→avoidscompartor→comparatorThese fixes help enhance readability and eliminate minor distractions during development and code reviews.
Additional Info
No logic or functionality has been modified. All changes are restricted to comments or non-executable doc annotations.