chore: fix some typos in comment #2880
Conversation
Signed-off-by: longxiangqiao <longxiangqiao@qq.com>
WalkthroughOhayo, sensei! This pull request involves minor documentation and comment corrections across several files in the project. The changes are primarily typographical fixes in README, shell scripts, and comments, focusing on spelling and grammar improvements. No functional changes were introduced to any of the scripts or documentation. Changes
These changes are purely cosmetic and do not impact the underlying code functionality. The documentation and comments are now more accurate and readable. 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
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
bin/saya/README.md (2)
40-40: Ohayo sensei! Let's maintain consistent list stylingThe unordered list at line 40 uses an asterisk (*) while other lists in the document use dashes (-). Let's keep our markdown styling consistent throughout.
- * Setup variables in or use environment variables ```bin/saya/scripts/0_account_setup.sh```, and run script + - Setup variables in or use environment variables ```bin/saya/scripts/0_account_setup.sh```, and run script🧰 Tools
🪛 Markdownlint (0.37.0)
40-40: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
169-169: Ohayo sensei! Small typo in the commentThe word "ephermal" should be "ephemeral" in the comment about Saya's operational modes.
- **Currently saya supports only persistent mode, ephermal will be implemented in future + **Currently saya supports only persistent mode, ephemeral will be implemented in future
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
bin/saya/README.md(2 hunks)bin/saya/saya.sh(1 hunks)scripts/cargo_bench.sh(1 hunks)scripts/spam_txs.sh(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- scripts/spam_txs.sh
- scripts/cargo_bench.sh
- bin/saya/saya.sh
🧰 Additional context used
🪛 Markdownlint (0.37.0)
bin/saya/README.md
40-40: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2880 +/- ##
==========================================
- Coverage 55.77% 55.76% -0.01%
==========================================
Files 446 446
Lines 57794 57794
==========================================
- Hits 32234 32230 -4
- Misses 25560 25564 +4 ☔ View full report in Codecov by Sentry. |
Description
fix some typos in comment
Related issue
Tests
Added to documentation?
Checklist
scripts/prettier.sh,scripts/rust_fmt.sh,scripts/cairo_fmt.sh)scripts/clippy.sh,scripts/docs.sh)Summary by CodeRabbit
saya.sh,cargo_bench.sh, andspam_txs.shscripts