Skip to content

Conversation

@solanaXpeter
Copy link
Contributor

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

  • Corrected misspellings:
    • ana
    • avoidavoids
    • compartorcomparator

These 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.

@solanaXpeter solanaXpeter requested a review from a team as a code owner September 24, 2025 09:07
@changeset-bot
Copy link

changeset-bot bot commented Sep 24, 2025

⚠️ No Changeset found

Latest commit: e89b1b7

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 Sep 24, 2025

Walkthrough

This 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

typo

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed The PR description clearly states the intent to correct minor typos in comments and documentation, enumerates specific examples (e.g., "an"→"a", "avoid"→"avoids", "compartor"→"comparator"), and asserts no functional changes. This aligns with the raw summary and PR objectives showing only non-executable .adoc edits, so the description is directly related to the changeset. Given the lenient criteria for this check, the description is adequate.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The title "Fix spelling issues" is a concise, single-sentence summary that accurately reflects the PR's primary change of correcting typos and minor grammar in documentation (e.g., "compartor" → "comparator" and article adjustments). It gives reviewers a clear, immediate understanding of the non-functional scope of the changes.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

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.

❤️ 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.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1078ecb and 4b7fa51.

📒 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 ernestognw changed the base branch from master to typo-fixes September 24, 2025 15:07
@ernestognw ernestognw changed the title docs: Fix spelling issues Fix spelling issues Sep 24, 2025
Copy link
Member

@ernestognw ernestognw left a comment

Choose a reason for hiding this comment

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

Thanks!

@ernestognw ernestognw merged commit 22a3aa5 into OpenZeppelin:typo-fixes Sep 24, 2025
12 of 14 checks passed
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.

2 participants