-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
chore: fix spelling errors #21235
chore: fix spelling errors #21235
Conversation
WalkthroughWalkthroughThe recent changes involve minor corrections in the blockchain governance documentation and related codebase. Primarily, typographical errors were addressed, including the standardization of variable names. These corrections enhance clarity and professionalism without impacting the functionality or logic of the code. The adjustments ensure accurate terminology in command usage and improve the overall readability of the documentation. Changes
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 as PR comments)
Additionally, you can add 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
Outside diff range, codebase verification and nitpick comments (2)
x/gov/README.md (2)
310-310
: Consider streamlining the sentence for clarity.The phrase can be made more concise: "Communities should use the governance mechanism and a 'signaling proposal' to amend their original constitution."
- Communities wishing to make amendments to their original constitution should use the governance mechanism and a "signaling proposal" to do exactly that. + Communities should use the governance mechanism and a "signaling proposal" to amend their original constitution.Tools
LanguageTool
[style] ~310-~310: Consider shortening this phrase to strengthen your wording.
Context: ... by governance. Communities wishing to make amendments to their original constitution should use ...(MAKE_CORRECTIONS)
320-320
: Consider using "arise" for stronger wording.The phrase "come up" can be replaced with "arise" for a more formal tone: "so that when difficult questions arise, the constitution can provide guidance."
- so that when difficult questions come up, the constitution can provide guidance + so that when difficult questions arise, the constitution can provide guidanceTools
LanguageTool
[style] ~320-~320: Consider using “arise” to strengthen your wording.
Context: ...nesis, so that when difficult questions come up, the constitution can provide guidance ...(QUESTIONS_COME_UP)
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (4)
- x/gov/README.md (4 hunks)
- x/gov/autocli.go (1 hunks)
- x/gov/keeper/deposit.go (2 hunks)
- x/gov/keeper/msg_server_test.go (1 hunks)
Files skipped from review due to trivial changes (3)
- x/gov/autocli.go
- x/gov/keeper/deposit.go
- x/gov/keeper/msg_server_test.go
Additional context used
Path-based instructions (1)
x/gov/README.md (1)
Pattern
**/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
LanguageTool
x/gov/README.md
[style] ~310-~310: Consider shortening this phrase to strengthen your wording.
Context: ... by governance. Communities wishing to make amendments to their original constitution should use ...(MAKE_CORRECTIONS)
[style] ~320-~320: Consider using “arise” to strengthen your wording.
Context: ...nesis, so that when difficult questions come up, the constitution can provide guidance ...(QUESTIONS_COME_UP)
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.
Thanks!
(cherry picked from commit 6f86b32)
Description
Fix spelling errors
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!
in the type prefix if API or client breaking changeCHANGELOG.md
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
Documentation
Bug Fixes
Tests