Skip to content

fix(contracts): n-01 typographical errors#446

Open
0xisk wants to merge 1 commit intomainfrom
fix/n-01
Open

fix(contracts): n-01 typographical errors#446
0xisk wants to merge 1 commit intomainfrom
fix/n-01

Conversation

@0xisk
Copy link
Copy Markdown
Member

@0xisk 0xisk commented Apr 10, 2026

Types of changes

What types of changes does your code introduce to OpenZeppelin Midnight Contracts?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

PartiallyFix #434

PR Checklist

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

Summary by CodeRabbit

  • Documentation
    • Corrected multiple documentation inaccuracies across contract files, including spelling corrections in function descriptions and module documentation to improve clarity and consistency.

@0xisk 0xisk requested a review from andrew-fleming April 10, 2026 11:39
@0xisk 0xisk self-assigned this Apr 10, 2026
@0xisk 0xisk added the audit Issues reported by an audit label Apr 10, 2026
@0xisk 0xisk requested review from a team as code owners April 10, 2026 11:39
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3af7209b-8727-4b3d-addf-7236e6e94639

📥 Commits

Reviewing files that changed from the base of the PR and between 736e289 and e657396.

📒 Files selected for processing (5)
  • contracts/src/access/Ownable.compact
  • contracts/src/access/ShieldedAccessControl.compact
  • contracts/src/access/ZOwnablePK.compact
  • contracts/src/token/NonFungibleToken.compact
  • contracts/src/utils/Utils.compact

Walkthrough

Documentation-only changes correcting spelling errors, removing redundant words, and updating module naming conventions across five contract files. No functional logic or control flow modifications.

Changes

Cohort / File(s) Summary
Documentation Corrections
contracts/src/access/Ownable.compact, contracts/src/access/ShieldedAccessControl.compact, contracts/src/access/ZOwnablePK.compact, contracts/src/token/NonFungibleToken.compact, contracts/src/utils/Utils.compact
Fixed spelling errors ("assertOnlyOnwer" → "assertOnlyOwner"), removed redundant words ("the the" → "the", "is is" → "is"), and standardized module documentation name ("Shielded AccessControl" → "ShieldedAccessControl").

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • andrew-fleming
  • emnul

Poem

🐰 Hop through the docs, I've found the flaws,
Typos and doubled words without a pause,
With whisker precision, each sentence refined,
Clean documentation, perfectly designed!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR addresses 5 of 7 identified typographical issues from #434 but omits 2 issues: the 'than' vs 'to' error and the step numbering/missing space issues in Uint128. Address the remaining typographical errors: the 'than' to 'to' fix in eq(Uint<128>) docstring and the step numbering/missing space issues in Uint128 circuits.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main change: fixing typographical errors across the contracts codebase.
Out of Scope Changes check ✅ Passed All changes are directly related to fixing typographical errors documented in #434; no unrelated modifications are present.
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
  • Commit unit tests in branch fix/n-01

Comment @coderabbitai help to get the list of available commands and usage tips.

@0xisk 0xisk linked an issue Apr 10, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

audit Issues reported by an audit

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

N-01: Typographical Errors

1 participant