chore: fix functions' comments (#20974)

This commit is contained in:
winniehere 2024-07-17 19:52:06 +08:00 committed by GitHub
parent 2d5983c829
commit 49bc189df1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
21 changed files with 25 additions and 25 deletions

View File

@ -2086,7 +2086,7 @@ func (x *ConfigResponse) GetHaltHeight() uint64 {
return 0
}
// StateRequest defines the request structure for the status of a node.
// StatusRequest defines the request structure for the status of a node.
type StatusRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache

View File

@ -2881,7 +2881,7 @@ func (x *AccountsResponse) GetPagination() *v1beta1.PageResponse {
return nil
}
// QueryDisableListRequest is the request type for the Query/DisabledList RPC method.
// QueryDisabledListRequest is the request type for the Query/DisabledList RPC method.
type QueryDisabledListRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache

View File

@ -30,7 +30,7 @@ const (
type QueryClient interface {
// Account returns account permissions.
Account(ctx context.Context, in *QueryAccountRequest, opts ...grpc.CallOption) (*AccountResponse, error)
// Account returns account permissions.
// Accounts returns multiple accounts permissions.
Accounts(ctx context.Context, in *QueryAccountsRequest, opts ...grpc.CallOption) (*AccountsResponse, error)
// DisabledList returns a list of disabled message urls
DisabledList(ctx context.Context, in *QueryDisabledListRequest, opts ...grpc.CallOption) (*DisabledListResponse, error)
@ -77,7 +77,7 @@ func (c *queryClient) DisabledList(ctx context.Context, in *QueryDisabledListReq
type QueryServer interface {
// Account returns account permissions.
Account(context.Context, *QueryAccountRequest) (*AccountResponse, error)
// Account returns account permissions.
// Accounts returns multiple accounts permissions.
Accounts(context.Context, *QueryAccountsRequest) (*AccountsResponse, error)
// DisabledList returns a list of disabled message urls
DisabledList(context.Context, *QueryDisabledListRequest) (*DisabledListResponse, error)

View File

@ -11432,7 +11432,7 @@ func (x *QuerySupplyByQueryStringResponse) GetAmount() uint64 {
return 0
}
// QueryNFTstRequest is the request type for the Query/NFTs RPC method
// QueryNFTsRequest is the request type for the Query/NFTs RPC method
type QueryNFTsRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache

View File

@ -139,7 +139,7 @@ func (m *ConfigResponse) GetHaltHeight() uint64 {
return 0
}
// StateRequest defines the request structure for the status of a node.
// StatusRequest defines the request structure for the status of a node.
type StatusRequest struct {
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -219,7 +219,7 @@ func (m *AccountsResponse) GetPagination() *query.PageResponse {
return nil
}
// QueryDisableListRequest is the request type for the Query/DisabledList RPC method.
// QueryDisabledListRequest is the request type for the Query/DisabledList RPC method.
type QueryDisabledListRequest struct {
}
@ -363,7 +363,7 @@ const _ = grpc.SupportPackageIsVersion4
type QueryClient interface {
// Account returns account permissions.
Account(ctx context.Context, in *QueryAccountRequest, opts ...grpc.CallOption) (*AccountResponse, error)
// Account returns account permissions.
// Accounts returns multiple accounts permissions.
Accounts(ctx context.Context, in *QueryAccountsRequest, opts ...grpc.CallOption) (*AccountsResponse, error)
// DisabledList returns a list of disabled message urls
DisabledList(ctx context.Context, in *QueryDisabledListRequest, opts ...grpc.CallOption) (*DisabledListResponse, error)
@ -408,7 +408,7 @@ func (c *queryClient) DisabledList(ctx context.Context, in *QueryDisabledListReq
type QueryServer interface {
// Account returns account permissions.
Account(context.Context, *QueryAccountRequest) (*AccountResponse, error)
// Account returns account permissions.
// Accounts returns multiple accounts permissions.
Accounts(context.Context, *QueryAccountsRequest) (*AccountsResponse, error)
// DisabledList returns a list of disabled message urls
DisabledList(context.Context, *QueryDisabledListRequest) (*DisabledListResponse, error)

View File

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

View File

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

View File

@ -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{})

View File

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

View File

@ -618,7 +618,7 @@ func (m *QuerySupplyByQueryStringResponse) GetAmount() uint64 {
return 0
}
// QueryNFTstRequest is the request type for the Query/NFTs RPC method
// QueryNFTsRequest is the request type for the Query/NFTs RPC method
type QueryNFTsRequest struct {
// class_id associated with the nft
ClassId string `protobuf:"bytes,1,opt,name=class_id,json=classId,proto3" json:"class_id,omitempty"`

View File

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

View File

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