From 25e99c54bac10e5680c25de7da38e1d5444907f9 Mon Sep 17 00:00:00 2001 From: Tuan Tran Date: Mon, 8 Jul 2024 21:21:07 +0700 Subject: [PATCH] chore(docs): comments should begin with the name of the thing being described (#20903) --- client/flags/flags.go | 4 ++-- client/rpc/tx.go | 2 +- crypto/hd/algo.go | 2 +- crypto/keyring/keyring.go | 2 +- crypto/keys/multisig/codec.go | 1 + 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/client/flags/flags.go b/client/flags/flags.go index 801b7f5796..ea8d5794d5 100644 --- a/client/flags/flags.go +++ b/client/flags/flags.go @@ -18,7 +18,7 @@ const ( DefaultGasLimit = 200000 GasFlagAuto = "auto" - // DefaultKeyringBackend + // DefaultKeyringBackend defines the default keyring backend to be used DefaultKeyringBackend = keyring.BackendOS // BroadcastSync defines a tx broadcasting mode where the client waits for @@ -86,7 +86,7 @@ const ( // FlagOutput is the flag to set the output format. // This differs from FlagOutputDocument that is used to set the output file. FlagOutput = "output" - // Logging flags + // FlagLogLevel defines the flag for setting the log level FlagLogLevel = "log_level" FlagLogFormat = "log_format" FlagLogNoColor = "log_no_color" diff --git a/client/rpc/tx.go b/client/rpc/tx.go index f5de0dfb1d..064859da8e 100644 --- a/client/rpc/tx.go +++ b/client/rpc/tx.go @@ -94,7 +94,7 @@ func QueryEventForTxCmd() *cobra.Command { return WaitTxCmd() } -// WaitTx returns a CLI command that waits for a transaction with the given hash to be included in a block. +// WaitTxCmd returns a CLI command that waits for a transaction with the given hash to be included in a block. func WaitTxCmd() *cobra.Command { cmd := &cobra.Command{ Use: "wait-tx [hash]", diff --git a/crypto/hd/algo.go b/crypto/hd/algo.go index 32fb3af738..885490c811 100644 --- a/crypto/hd/algo.go +++ b/crypto/hd/algo.go @@ -19,7 +19,7 @@ const ( // Ed25519Type represents the Ed25519Type signature system. // It is currently not supported for end-user keys (wallets/ledgers). Ed25519Type = PubKeyType("ed25519") - // Ed25519Type represents the Ed25519Type signature system. + // Bls12_381Type represents the Bls12_381Type signature system. // It is currently not supported for end-user keys (wallets/ledgers). Bls12_381Type = PubKeyType("bls12_381") // Sr25519Type represents the Sr25519Type signature system. diff --git a/crypto/keyring/keyring.go b/crypto/keyring/keyring.go index c125383d54..aee52a6256 100644 --- a/crypto/keyring/keyring.go +++ b/crypto/keyring/keyring.go @@ -59,7 +59,7 @@ type Keyring interface { // Backend get the backend type used in the keyring config: "file", "os", "kwallet", "pass", "test", "memory". Backend() string - // Get the db keyring used in the keystore. + // DB get the db keyring used in the keystore. DB() keyring.Keyring // List all keys. diff --git a/crypto/keys/multisig/codec.go b/crypto/keys/multisig/codec.go index 47aa70060f..50877814e5 100644 --- a/crypto/keys/multisig/codec.go +++ b/crypto/keys/multisig/codec.go @@ -13,6 +13,7 @@ import ( // TODO: Figure out API for others to either add their own pubkey types, or // to make verify / marshal accept a AminoCdc. const ( + // PubKeyAminoRoute defines the amino route for a multisig threshold public key PubKeyAminoRoute = "tendermint/PubKeyMultisigThreshold" )