docs(x/gov): fix typos #21588
docs(x/gov): fix typos #21588
Conversation
hattizai
requested review from
julienrbrt,
sontrinh16 and
a team
as code owners
WalkthroughWalkthroughThe pull request includes grammatical corrections and minor rephrasing in the governance documentation. These changes aim to improve clarity and readability while maintaining the original content and functionality. Specific adjustments involve correcting phrases and ensuring proper grammatical structure throughout the document. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Governance
participant System
User->>Governance: Submit proposal
Governance->>System: Validate proposal
System-->>Governance: Proposal valid
Governance->>User: Notify proposal status
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: 1
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- x/gov/README.md (8 hunks)
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
[grammar] ~95-~95: This is normally spelled as one word.
Context: ...cute any message, effectively acting as super user. ::: ### Deposit To prevent spam, pro...(SUPER_COMPOUNDS)
[uncategorized] ~276-~276: Possible missing comma found.
Context: ...roposal gets vetoed. *BurnVoteQuorumburns the proposal deposit if the vote does n...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~310-~310: Consider shortening this phrase to strengthen your wording.
Context: ...d by governance. Communities wishing to make amendments to their original constitution should use ...(MAKE_CORRECTIONS)
Additional comments not posted (5)
x/gov/README.md (5)
66-66: Correction: Grammar improvement for clarity.The phrase "divided in a few steps" has been correctly changed to "divided into a few steps" to improve grammatical accuracy and readability.
95-95: Correction: Clarification of governance capabilities.The phrase "let governance can execute" has been changed to "let governance be able to execute," which corrects the grammatical structure and clarifies the meaning.
Tools
LanguageTool
[grammar] ~95-~95: This is normally spelled as one word.
Context: ...cute any message, effectively acting as super user. ::: ### Deposit To prevent spam, pro...(SUPER_COMPOUNDS)
219-219: Correction: Improved grammatical structure.The phrase "a threshold a NO votes" has been corrected to "a threshold of NO votes," which fixes a typographical error and enhances the sentence structure.
285-285: Correction: Clarification of execution limits.The phrase "the vote does not reach quorum" has been changed to "if the vote does not reach quorum," which clarifies the conditional nature of the statement and improves the flow of the text.
276-276: Suggestion: Add a comma for clarity.Consider adding a comma after "vetoed" to improve readability:
- * When the proposal is vetoed with greater than 1/3, deposits will be burned from the governance `ModuleAccount` and the proposal information along with its deposit information will be removed from state. + * When the proposal is vetoed, with greater than 1/3, deposits will be burned from the governance `ModuleAccount` and the proposal information along with its deposit information will be removed from state.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~276-~276: Possible missing comma found.
Context: ...roposal gets vetoed. *BurnVoteQuorumburns the proposal deposit if the vote does n...(AI_HYDRA_LEO_MISSING_COMMA)
|
|
||
| This constitution is designed to be immutable, and placed only in genesis, though that could change over time by a pull request to the cosmos-sdk that allows for the constitution to be changed by governance. Communities wishing to make amendments to their original constitution should use the governance mechanism and a "signaling proposal" to do exactly that. | ||
| This constitution is designed to be immutable, and placed only in genesis, though that could change over time by a pull request to the cosmos-sdk that allows for the constitution to be changed by governance. Communities wishing to make amendments to their original constitution should use the governance mechanism and a "signaling proposal" to do exactly that. |
There was a problem hiding this comment.
Suggestion: Simplify the phrase for stronger impact.
Consider simplifying the phrase to make it more direct and impactful:
- Communities wishing to make amendments to their original constitution should use the governance mechanism and a "signaling proposal" to do exactly that.
+ Communities wanting to amend their original constitution should use the governance mechanism and a "signaling proposal."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.
| This constitution is designed to be immutable, and placed only in genesis, though that could change over time by a pull request to the cosmos-sdk that allows for the constitution to be changed by governance. Communities wishing to make amendments to their original constitution should use the governance mechanism and a "signaling proposal" to do exactly that. | |
| This constitution is designed to be immutable, and placed only in genesis, though that could change over time by a pull request to the cosmos-sdk that allows for the constitution to be changed by governance. Communities wanting to amend their original constitution should use the governance mechanism and a "signaling proposal." |
Tools
LanguageTool
[style] ~310-~310: Consider shortening this phrase to strengthen your wording.
Context: ...d by governance. Communities wishing to make amendments to their original constitution should use ...(MAKE_CORRECTIONS)
julienrbrt
added
the
backport/v0.52.x
(cherry picked from commit 644b263)
fix some typos & grammar errors to improve the doc's readability. :)
Summary by CodeRabbit