feat(client/v2): override short description in generated command #20266
Conversation
WalkthroughWalkthroughThe recent updates aim to enhance command descriptions within the autocli module, providing clearer user guidance. Changes include setting default short descriptions for query and message commands, updating logic in Go files to handle missing descriptions, and introducing an optional 'short' parameter in the proto definition. These adjustments improve the clarity and informativeness of command interfaces in the application. Changes
Recent Review DetailsConfiguration used: .coderabbit.yml Files selected for processing (1)
Additional Context UsedLanguageTool (29)
Path-based Instructions (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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
Would be great to get this backported to |
Yes, we can add this in the next client/v2 release (ref #19530) |
julienrbrt
added
the
backport/v0.50.x
![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
Out of diff range and nitpick comments (3)
client/v2/CHANGELOG.md (3)
Line range hint
52-52: Add a space after the comma for better readability.- * Note, the given command must have a `client.Context` in its context. + * Note, the given command must have a `client.Context` in its context.
Line range hint
54-54: Add a space after the period for better readability.- TxConfig should always be set in the `client.Context` in `root.go` of an app. + TxConfig should always be set in the `client.Context` in `root.go` of an app.
Line range hint
65-65: Add a comma after 'Instead' for grammatical correctness.- Instead client/v2 uses the address codecs present in the context + Instead, client/v2 uses the address codecs present in the context
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
| @@ -43,6 +43,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ | |||
| * [#18626](https://github.com/cosmos/cosmos-sdk/pull/18626) Support for off-chain signing and verification of a file. | |||
| * [#18461](https://github.com/cosmos/cosmos-sdk/pull/18461) Support governance proposals. | |||
| * [#19039](https://github.com/cosmos/cosmos-sdk/pull/19039) Add support for pubkey in autocli. | |||
| * [#20266](https://github.com/cosmos/cosmos-sdk/pull/20266) Ability to override the short description in AutoCLI-generated top-level commands. | |||
There was a problem hiding this comment.
Ensure consistency in the description of the feature.
- Ability to override the short description in AutoCLI-generated top-level commands.
+ Ability to override short descriptions in AutoCLI-generated top-level commands.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.
| * [#20266](https://github.com/cosmos/cosmos-sdk/pull/20266) Ability to override the short description in AutoCLI-generated top-level commands. | |
| * [#20266](https://github.com/cosmos/cosmos-sdk/pull/20266) Ability to override short descriptions in AutoCLI-generated top-level commands. |
julienrbrt
changed the title
) Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> (cherry picked from commit 7a505ad) # Conflicts: # api/cosmos/autocli/v1/options.pulsar.go # client/v2/CHANGELOG.md # proto/cosmos/autocli/v1/options.proto
Description
Closes: #XXXX
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.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.
I have...
Summary by CodeRabbit
New Features
Improvements
Documentation
ServiceCommandDescriptorto facilitate clearer command descriptions.