-
Notifications
You must be signed in to change notification settings - Fork 68
Fix typos #776
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
base: main
Are you sure you want to change the base?
Fix typos #776
Conversation
WalkthroughDocumentation-only typo corrections across multiple files. No code, logic, API, or control-flow changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
contracts/contracts/Staking.md (3)
22-22: Typo: “Rollp” → “Rollup”User-facing heading.
-**Rollp Verify** +**Rollup Verify**
11-11: Grammar: remove duplicated “yet” and add passiveImproves correctness and clarity.
-- MorphToken has not yet issued yet +- MorphToken has not yet been issued
63-63: Punctuation/grammar fixReplace non-ASCII comma and improve phrasing.
-- `L1` Claim allowed until reach unlock height,remove staker info after claiming +- `L1` Claim allowed until reaching the unlock height; remove staker info after claiming
🧹 Nitpick comments (7)
contracts/contracts/libraries/codec/BatchHeaderCodecV1.sol (1)
21-23: Grammar fix: “are the fields” (and optionally fix code fence).Change “Below is the fields” to “Below are the fields”. Also, there’s a closing code fence on Line 23 without a matching opener in this section—either add an opening “```text” above the list or remove the closing fence.
-/// @dev Below is the fields for `BatchHeader` V1 +/// @dev Below are the fields for `BatchHeader` V1prover/contracts/src/PlonkVerifier.sol (1)
765-771: Quick pass to fix a few remaining doc typos.Several minor typos remain in nearby comments; suggest correcting in this PR.
- // at this point we have mPtr = [ b1 || b2] where b1 is on 32byes and b2 in 16bytes. + // at this point we have mPtr = [ b1 || b2 ] where b1 is on 32 bytes and b2 is 16 bytes. - /// @param q pointer to the second point (calladata) + /// @param q pointer to the second point (calldata) - /// @parma dst pointer storing the result + /// @param dst pointer storing the result - /// @parma dst pointer storing the result + /// @param dst pointer storing the resultAlso applies to: 1226-1233, 1239-1246, 1253-1261
contracts/README.md (1)
11-12: Sweep remaining typos/formatting in this section.A few obvious nits nearby worth fixing while touching docs.
-| [`L1CrossDomainMessenger`](../../specs/messengers.md) | [`ResolvedDelegateProxy`](./contracts/legacy/ResolvedDelegateProxy.sol) | High-level interface for sending messages to and receiving messages from M +| [`L1CrossDomainMessenger`](../../specs/messengers.md) | [`ResolvedDelegateProxy`](./contracts/legacy/ResolvedDelegateProxy.sol) | High-level interface for sending messages to and receiving messages from Morph -| [`L1StandardBridge`](../../specs/bridges.md) | [`L1ChugSplashProxy`](./contracts/legacy/L1ChugSplashProxy.sol) | Standardized system for transfering ERC20 tokens to/from Mo r p h +| [`L1StandardBridge`](../../specs/bridges.md) | [`L1ChugSplashProxy`](./contracts/legacy/L1ChugSplashProxy.sol) | Standardized system for transferring ERC20 tokens to/from Morph -| [`AddressManager`](contracts/deployment/AddressManager.solol) | L1 | - | Legacy upgrade mechanism (unused in Bedrock) +| [`AddressManager`](contracts/deployment/AddressManager.sol) | L1 | - | Legacy upgrade mechanism (unused in Bedrock) -2. Fill out this file according to the `deployConfigSpec` located inside of the [`hardhat.config.ts](./hardhat.config.ts) +2. Fill out this file according to the `deployConfigSpec` located inside of the [`hardhat.config.ts`](./hardhat.config.ts)Also applies to: 35-36, 94-95
contracts/contracts/libraries/codec/BatchHeaderCodecV0.sol (1)
16-17: Nit: “Preview state root” → “Previous state root”.Matches the field name
prevStateHash.-/// * prevStateHash 32 bytes32 89 Preview state root +/// * prevStateHash 32 bytes32 89 Previous state rootcontracts/contracts/Staking.md (3)
118-118: Capitalize L2 and prefer “called by” phrasing for clarityKeeps terminology consistent with the rest of the doc and improves readability.
- - Update sequencer set, call from l2 staking contract + - Update sequencer set, called by the L2 Staking contract
126-127: Consistency: capitalize L2; streamline phrasingAligns with surrounding sections and reduces redundancy (“delegator's delegation reward”).
- - Compute delegator's delegation reward, call from l2 staking contract + - Compute a delegator's reward, called by the L2 Staking contract - - Compute sequencer's commission, call from l2 staking contract + - Compute a sequencer's commission, called by the L2 Staking contract
16-16: Terminology: capitalize ETHFollows standard ticker capitalization.
-- `L1` Register and stake eth to become staker +- `L1` Register and stake ETH to become staker
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (6)
contracts/README.md(1 hunks)contracts/contracts/Staking.md(1 hunks)contracts/contracts/l2/gateways/L2CustomERC20Gateway.sol(1 hunks)contracts/contracts/libraries/codec/BatchHeaderCodecV0.sol(1 hunks)contracts/contracts/libraries/codec/BatchHeaderCodecV1.sol(1 hunks)prover/contracts/src/PlonkVerifier.sol(2 hunks)
🔇 Additional comments (5)
prover/contracts/src/PlonkVerifier.sol (2)
263-265: Typo fix LGTM.“evaluations” correction reads well.
806-810: Typo fix LGTM.“number” correction is correct.
contracts/README.md (1)
82-83: Typo fix LGTM.“targeted” is correct.
contracts/contracts/libraries/codec/BatchHeaderCodecV0.sol (1)
70-71: Typo fix LGTM.Return description reads correctly now.
contracts/contracts/l2/gateways/L2CustomERC20Gateway.sol (1)
14-15: Typo fix LGTM.Redundant “tokens” removed.
Fix typos
Summary by CodeRabbit