chore: fix functions' comments (cosmos#20974)

decentrio · Jul 17, 2024 · 49bc189 · 49bc189
1 parent 2d5983c
commit 49bc189
Show file tree

Hide file tree

Showing 21 changed files with 25 additions and 25 deletions.
diff --git a/api/cosmos/base/node/v1beta1/query.pulsar.go b/api/cosmos/base/node/v1beta1/query.pulsar.go
diff --git a/api/cosmos/circuit/v1/query.pulsar.go b/api/cosmos/circuit/v1/query.pulsar.go
diff --git a/api/cosmos/circuit/v1/query_grpc.pb.go b/api/cosmos/circuit/v1/query_grpc.pb.go
diff --git a/api/cosmos/nft/v1beta1/query.pulsar.go b/api/cosmos/nft/v1beta1/query.pulsar.go
diff --git a/client/grpc/node/query.pb.go b/client/grpc/node/query.pb.go
diff --git a/docs/architecture/adr-043-nft-module.md b/docs/architecture/adr-043-nft-module.md
@@ -253,7 +253,7 @@ message QuerySupplyResponse {
   uint64 amount = 1;
 }
 
-// QueryNFTstRequest is the request type for the Query/NFTs RPC method
+// QueryNFTsRequest is the request type for the Query/NFTs RPC method
 message QueryNFTsRequest {
   string                                class_id   = 1;
   string                                owner      = 2;

diff --git a/proto/cosmos/base/node/v1beta1/query.proto b/proto/cosmos/base/node/v1beta1/query.proto
@@ -30,7 +30,7 @@ message ConfigResponse {
   uint64 halt_height         = 4;
 }
 
-// StateRequest defines the request structure for the status of a node.
+// StatusRequest defines the request structure for the status of a node.
 message StatusRequest {}
 
 // StateResponse defines the response structure for the status of a node.

diff --git a/store/iavl/store.go b/store/iavl/store.go
@@ -163,7 +163,7 @@ func (st *Store) SetPruning(_ pruningtypes.PruningOptions) {
 	panic("cannot set pruning options on an initialized IAVL store")
 }
 
-// SetPruning panics as pruning options should be provided at initialization
+// GetPruning panics as pruning options should be provided at initialization
 // since IAVl accepts pruning options directly.
 func (st *Store) GetPruning() pruningtypes.PruningOptions {
 	panic("cannot get pruning options on an initialized IAVL store")

diff --git a/x/auth/keeper/deterministic_test.go b/x/auth/keeper/deterministic_test.go
@@ -107,7 +107,7 @@ func (suite *DeterministicTestSuite) SetupTest() {
 	suite.accountNumberLanes = 1
 }
 
-// createAndSetAccount creates a random account and sets to the keeper store.
+// createAndSetAccounts creates a random account and sets to the keeper store.
 func (suite *DeterministicTestSuite) createAndSetAccounts(t *rapid.T, count int) []sdk.AccountI {
 	accs := make([]sdk.AccountI, 0, count)
 

diff --git a/x/auth/vesting/types/codec.go b/x/auth/vesting/types/codec.go
@@ -26,7 +26,7 @@ func RegisterLegacyAminoCodec(cdc corelegacy.Amino) {
 	legacy.RegisterAminoMsg(cdc, &MsgCreatePeriodicVestingAccount{}, "cosmos-sdk/MsgCreatePeriodVestAccount")
 }
 
-// RegisterInterface associates protoName with AccountI and VestingAccount
+// RegisterInterfaces associates protoName with AccountI and VestingAccount
 // Interfaces and creates a registry of it's concrete implementations
 func RegisterInterfaces(registrar registry.InterfaceRegistrar) {
 	registrar.RegisterInterface(

diff --git a/x/bank/simulation/genesis_test.go b/x/bank/simulation/genesis_test.go
@@ -59,7 +59,7 @@ func TestRandomizedGenState(t *testing.T) {
 	}
 }
 
-// TestRandomizedGenState tests abnormal scenarios of applying RandomizedGenState.
+// TestRandomizedGenState1 tests abnormal scenarios of applying RandomizedGenState.
 func TestRandomizedGenState1(t *testing.T) {
 	interfaceRegistry := codectypes.NewInterfaceRegistry()
 	cdc := codec.NewProtoCodec(interfaceRegistry)

diff --git a/x/circuit/keeper/query.go b/x/circuit/keeper/query.go
@@ -35,7 +35,7 @@ func (qs QueryServer) Account(ctx context.Context, req *types.QueryAccountReques
 	return &types.AccountResponse{Permission: &perms}, nil
 }
 
-// Account returns account permissions.
+// Accounts returns multiple accounts permissions.
 func (qs QueryServer) Accounts(ctx context.Context, req *types.QueryAccountsRequest) (*types.AccountsResponse, error) {
 	results, pageRes, err := query.CollectionPaginate(
 		ctx,

diff --git a/x/circuit/proto/cosmos/circuit/v1/query.proto b/x/circuit/proto/cosmos/circuit/v1/query.proto
@@ -16,7 +16,7 @@ service Query {
     option (google.api.http).get               = "/cosmos/circuit/v1/accounts/{address}";
   }
 
-  // Account returns account permissions.
+  // Accounts returns multiple accounts permissions.
   rpc Accounts(QueryAccountsRequest) returns (AccountsResponse) {
     option (cosmos.query.v1.module_query_safe) = true;
     option (google.api.http).get               = "/cosmos/circuit/v1/accounts";
@@ -52,7 +52,7 @@ message AccountsResponse {
   cosmos.base.query.v1beta1.PageResponse pagination = 2;
 }
 
-// QueryDisableListRequest is the request type for the Query/DisabledList RPC method.
+// QueryDisabledListRequest is the request type for the Query/DisabledList RPC method.
 message QueryDisabledListRequest {}
 
 // DisabledListResponse is the response type for the Query/DisabledList RPC method.

diff --git a/x/circuit/types/query.pb.go b/x/circuit/types/query.pb.go
diff --git a/x/distribution/simulation/genesis_test.go b/x/distribution/simulation/genesis_test.go
@@ -53,7 +53,7 @@ func TestRandomizedGenState(t *testing.T) {
 	require.Len(t, distrGenesis.ValidatorSlashEvents, 0)
 }
 
-// TestRandomizedGenState tests abnormal scenarios of applying RandomizedGenState.
+// TestRandomizedGenState1 tests abnormal scenarios of applying RandomizedGenState.
 func TestRandomizedGenState1(t *testing.T) {
 	interfaceRegistry := codectypes.NewInterfaceRegistry()
 	cdc := codec.NewProtoCodec(interfaceRegistry)

diff --git a/x/gov/simulation/genesis_test.go b/x/gov/simulation/genesis_test.go
@@ -77,7 +77,7 @@ func TestRandomizedGenState(t *testing.T) {
 	require.Equal(t, []*v1.Proposal{}, govGenesis.Proposals)
 }
 
-// TestRandomizedGenState tests abnormal scenarios of applying RandomizedGenState.
+// TestRandomizedGenState1 tests abnormal scenarios of applying RandomizedGenState.
 func TestRandomizedGenState1(t *testing.T) {
 	interfaceRegistry := codectypes.NewInterfaceRegistry()
 	cdc := codec.NewProtoCodec(interfaceRegistry)

diff --git a/x/mint/simulation/genesis_test.go b/x/mint/simulation/genesis_test.go
@@ -62,7 +62,7 @@ func TestRandomizedGenState(t *testing.T) {
 	require.Equal(t, "0.000000000000000000", mintGenesis.Minter.AnnualProvisions.String())
 }
 
-// TestRandomizedGenState tests abnormal scenarios of applying RandomizedGenState.
+// TestRandomizedGenState1 tests abnormal scenarios of applying RandomizedGenState.
 func TestRandomizedGenState1(t *testing.T) {
 	encCfg := moduletestutil.MakeTestEncodingConfig(codectestutil.CodecOptions{}, mint.AppModule{})
 

diff --git a/x/nft/proto/cosmos/nft/v1beta1/query.proto b/x/nft/proto/cosmos/nft/v1beta1/query.proto
@@ -171,7 +171,7 @@ message QuerySupplyByQueryStringResponse {
   uint64 amount = 1;
 }
 
-// QueryNFTstRequest is the request type for the Query/NFTs RPC method
+// QueryNFTsRequest is the request type for the Query/NFTs RPC method
 message QueryNFTsRequest {
   // class_id associated with the nft
   string class_id = 1;

diff --git a/x/nft/query.pb.go b/x/nft/query.pb.go
diff --git a/x/slashing/simulation/genesis_test.go b/x/slashing/simulation/genesis_test.go
@@ -59,7 +59,7 @@ func TestRandomizedGenState(t *testing.T) {
 	require.Len(t, slashingGenesis.SigningInfos, 0)
 }
 
-// TestRandomizedGenState tests abnormal scenarios of applying RandomizedGenState.
+// TestRandomizedGenState1 tests abnormal scenarios of applying RandomizedGenState.
 func TestRandomizedGenState1(t *testing.T) {
 	interfaceRegistry := codectypes.NewInterfaceRegistry()
 	cdc := codec.NewProtoCodec(interfaceRegistry)

diff --git a/x/staking/keeper/migrations.go b/x/staking/keeper/migrations.go
@@ -42,7 +42,7 @@ func (m Migrator) Migrate4to5(ctx context.Context) error {
 	return v5.MigrateStore(ctx, store, m.keeper.cdc, m.keeper.Logger)
 }
 
-// Migrate4to5 migrates x/staking state from consensus version 5 to 6.
+// Migrate5to6 migrates x/staking state from consensus version 5 to 6.
 func (m Migrator) Migrate5to6(ctx context.Context) error {
 	store := runtime.KVStoreAdapter(m.keeper.KVStoreService.OpenKVStore(ctx))
 	return v6.MigrateStore(ctx, store, m.keeper.cdc)