chore(docs): comments should begin with the name of the thing being described (#20903)

This commit is contained in:
Tuan Tran 2024-07-08 21:21:07 +07:00 committed by GitHub
parent acfd1ac30a
commit 25e99c54ba
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 6 additions and 5 deletions

View File

@ -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"

View File

@ -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]",

View File

@ -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.

View File

@ -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.

View File

@ -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"
)