fix: typos in documentation files #1580
Conversation
WalkthroughThe pull request involves a minor update to the README.md file in the common/bytecode directory. The change focuses on correcting the contract type terminology from "eth20" to "erc20" when describing ABI generation instructions. This modification aims to provide more accurate and consistent guidance for users working with contract deployment and ABI retrieval processes. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
common/bytecode/README.md (1)
Line range hint
1-25: Documentation structure looks good!The instructions are clear, well-organized, and the commands are consistent. The correction from "eth20" to "erc20" improves accuracy.
Consider adding a note about the required environment variable:
## How to pre deploy contracts? +> Note: These instructions assume you have set the ${SCROLLPATH} environment variable to point to your Scroll repository root. + * Please reference to https://github.com/scroll-tech/genesis-creator.🧰 Tools
🪛 LanguageTool
[uncategorized] ~24-~24: You might be missing the article “a” here.
Context: ...} make dev_docker ``` ## How to get contract abi? * Other contracts' step same to er...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~25-~25: The preposition “as” seems more likely in this position.
Context: ...tract abi? * Other contracts' step same to erc20, e.g: 1. Install solc. *R...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
🪛 Markdownlint (0.37.0)
28-28: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
common/bytecode/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
common/bytecode/README.md
[uncategorized] ~25-~25: The preposition “as” seems more likely in this position.
Context: ...tract abi? * Other contracts' step same to erc20, e.g: 1. Install solc. *R...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
| @@ -22,7 +22,7 @@ | |||
| ``` | |||
|
|
|||
| ## How to get contract abi? | |||
| * Other contracts' step same to eth20, e.g: | |||
| * Other contracts' step same to erc20, e.g: | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve grammar and clarity
The current phrase "Other contracts' step same to erc20" is grammatically incorrect.
Consider this clearer phrasing:
-* Other contracts' step same to erc20, e.g:
+* For other contracts, follow the same steps as erc20, e.g:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * Other contracts' step same to erc20, e.g: | |
| * For other contracts, follow the same steps as erc20, e.g: |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: The preposition “as” seems more likely in this position.
Context: ...tract abi? * Other contracts' step same to erc20, e.g: 1. Install solc. *R...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
Corrected
eth20toerc20Summary by CodeRabbit