docs(x/gov): Sync Example with Use in autocli #22768
Conversation
DongLieu
requested review from
julienrbrt,
sontrinh16,
a team,
alpe and
JulianToledano
as code owners
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces updates to the Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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
🧹 Outside diff range and nitpick comments (2)
x/gov/autocli.go (1)
150-150: Improve example string format consistencyThe example string format could be improved for better clarity and consistency:
- The placeholder
[msg-url]should be consistent with the command name which uses<msg-url>- There should be a space between
[msg-url]and the JSON parameter exampleConsider updating to:
- Example: fmt.Sprintf(`%s tx gov update-params-msg-url-params [msg-url]'{ params }'`, version.AppName), + Example: fmt.Sprintf(`%s tx gov update-params-msg-url-params <msg-url> '{ params }'`, version.AppName),x/distribution/autocli.go (1)
27-27: Standardize parameter placeholder formatThe example string uses
[validator-address]while the command'sUsefield uses<validator>. This inconsistency could confuse users.Consider updating to:
- Example: fmt.Sprintf(`$ %s query distribution validator-distribution-info [validator-address]`, version.AppName), + Example: fmt.Sprintf(`$ %s query distribution validator-distribution-info <validator-address>`, version.AppName),
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (2)
x/distribution/autocli.go(1 hunks)x/gov/autocli.go(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
x/gov/autocli.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
x/distribution/autocli.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
🔇 Additional comments (1)
x/distribution/autocli.go (1)
Line range hint 143-144: LGTM: Clear deprecation handling
The CommunityPoolSpend command is correctly marked as deprecated with Skip: true and includes a clear comment explaining the reason for deprecation in favor of the protocolpool functionality.
julienrbrt
changed the title
julienrbrt
added
the
backport/v0.52.x
(cherry picked from commit ec5225c)
Co-authored-by: Dong Lieu <[email protected]>
Description
Closes: #XXXX
in x/gov:
Use :
update-params-msg-url-paramsExample:
update-msg-params-proposalAuthor 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.mdReviewers 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
New Features
update-params-msg-url-paramstoupdate-msg-params-proposal.Deprecation
CommunityPoolSpendcommand as deprecated, encouraging the use of theprotocolpoolfunctionality instead.