Skip to content

docs: fix typos in BridgeMultiToken NatSpec#6505

Closed
0xAxiom wants to merge 4 commits into
OpenZeppelin:typo-fixesfrom
0xAxiom:docs/fix-bridgemultitoken-typo
Closed

docs: fix typos in BridgeMultiToken NatSpec#6505
0xAxiom wants to merge 4 commits into
OpenZeppelin:typo-fixesfrom
0xAxiom:docs/fix-bridgemultitoken-typo

Conversation

@0xAxiom
Copy link
Copy Markdown

@0xAxiom 0xAxiom commented May 10, 2026

Fix three small issues in the BridgeMultiToken contract NatSpec comment (contracts/crosschain/bridges/abstract/BridgeMultiToken.sol):

  • thoughthrough
  • duplicated the thethe
  • this functionsthese functions

Doc-only change, no behavioral or interface changes.

Fix three issues in the contract NatSpec:
- 'though' -> 'through'
- duplicated 'the the' -> 'the'
- 'this functions' -> 'these functions'
@0xAxiom 0xAxiom requested a review from a team as a code owner May 10, 2026 10:58
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 10, 2026

⚠️ No Changeset found

Latest commit: 5ee93b6

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
Copy Markdown
Contributor

coderabbitai Bot commented May 10, 2026

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 78f94651-cbd2-4614-8ceb-9e9dc849f860

📥 Commits

Reviewing files that changed from the base of the PR and between 8b010f9 and d03aee0.

📒 Files selected for processing (1)
  • contracts/crosschain/bridges/abstract/BridgeMultiToken.sol

Walkthrough

This pull request updates NatSpec documentation in BridgeMultiToken.sol, correcting the wording that describes how child contracts should implement and expose internal crosschain transfer functions. No executable code, interfaces, or contract logic is modified. The change consists of wording corrections only to lines 20-21.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: fix typos in BridgeMultiToken NatSpec' clearly and accurately summarizes the main change: documentation-only corrections to NatSpec comments.
Description check ✅ Passed The description is directly related to the changeset, providing specific details about the three typos fixed in the BridgeMultiToken NatSpec comment.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@Amxx Amxx changed the base branch from master to typo-fixes May 14, 2026 08:06
@socket-security
Copy link
Copy Markdown

socket-security Bot commented May 14, 2026

No dependency changes detected. Learn more about Socket for GitHub.

👍 No dependency changes detected in pull request

@Amxx
Copy link
Copy Markdown
Collaborator

Amxx commented May 14, 2026

Already covered by the typo-fixes branch

@Amxx Amxx closed this May 14, 2026
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.

2 participants