refactor(cli): Standardize Use field convention and update readme (#21369)
This commit is contained in:
+1
-1
@@ -218,7 +218,7 @@ for. Each module documents its respective events under 'xx_events.md'.
|
||||
// QueryBlockCmd implements the default command for a Block query.
|
||||
func QueryBlockCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "block --type=[height|hash] [height|hash]",
|
||||
Use: "block --type={height|hash} [height|hash]",
|
||||
Short: "Query for a committed block by height, hash, or event(s)",
|
||||
Long: "Query for a specific committed block using the CometBFT RPC `block` and `block_by_hash` method",
|
||||
Example: strings.TrimSpace(fmt.Sprintf(`
|
||||
|
||||
@@ -21,7 +21,7 @@ import (
|
||||
// ModuleHashByHeightQuery retrieves the module hashes at a given height.
|
||||
func ModuleHashByHeightQuery[T servertypes.Application](appCreator servertypes.AppCreator[T]) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "module-hash-by-height [height]",
|
||||
Use: "module-hash-by-height <height>",
|
||||
Short: "Get module hashes at a given height",
|
||||
Long: "Get module hashes at a given height. This command is useful for debugging and verifying the state of the application at a given height. Daemon should not be running when calling this command.",
|
||||
Example: fmt.Sprintf("%s module-hash-by-height 16841115", version.AppName),
|
||||
|
||||
+1
-1
@@ -667,7 +667,7 @@ func InPlaceTestnetCreator[T types.Application](testnetAppCreator types.AppCreat
|
||||
}
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "in-place-testnet [newChainID] [newOperatorAddress]",
|
||||
Use: "in-place-testnet <newChainID> <newOperatorAddress>",
|
||||
Short: "Create and start a testnet from current local state",
|
||||
Long: `Create and start a testnet from current local state.
|
||||
After utilizing this command the network will start. If the network is stopped,
|
||||
|
||||
@@ -25,7 +25,7 @@ var CometBFTAutoCLIDescriptor = &autocliv1.ServiceCommandDescriptor{
|
||||
},
|
||||
{
|
||||
RpcMethod: "GetBlockByHeight",
|
||||
Use: "block-by-height [height]",
|
||||
Use: "block-by-height <height>",
|
||||
Short: "Query for a committed block by height",
|
||||
Long: "Query for a specific committed block using the CometBFT RPC `block_by_height` method",
|
||||
PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "height"}},
|
||||
@@ -38,7 +38,7 @@ var CometBFTAutoCLIDescriptor = &autocliv1.ServiceCommandDescriptor{
|
||||
},
|
||||
{
|
||||
RpcMethod: "GetValidatorSetByHeight",
|
||||
Use: "validator-set-by-height [height]",
|
||||
Use: "validator-set-by-height <height>",
|
||||
Short: "Query for a validator set by height",
|
||||
PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "height"}},
|
||||
},
|
||||
|
||||
@@ -233,7 +233,7 @@ for. Each module documents its respective events under 'xx_events.md'.
|
||||
// QueryBlockCmd implements the default command for a Block query.
|
||||
func (s *CometBFTServer[T]) QueryBlockCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "block --type=[height|hash] [height|hash]",
|
||||
Use: "block --type={height|hash} <height|hash>",
|
||||
Short: "Query for a committed block by height, hash, or event(s)",
|
||||
Long: "Query for a specific committed block using the CometBFT RPC `block` and `block_by_hash` method",
|
||||
Example: strings.TrimSpace(fmt.Sprintf(`
|
||||
|
||||
Reference in New Issue
Block a user