Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(proto): fix comments #20679

Merged
merged 2 commits into from
Jun 17, 2024
Merged

chore(proto): fix comments #20679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ca8462
fix comments
winniehere Jun 16, 2024
f70b55f
Merge branch 'main' into chore/comment
julienrbrt Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/cosmos/app/v1alpha1/query.pulsar.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/cosmos/staking/v1beta1/staking.pulsar.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/cosmos/app/v1alpha1/query.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ service Query {
// QueryConfigRequest is the Query/Config request type.
message QueryConfigRequest {}

// QueryConfigRequest is the Query/Config response type.
// QueryConfigResponse is the Query/Config response type.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

The renaming of QueryConfigRequest to QueryConfigResponse is incomplete. The old type name QueryConfigRequest still exists in the following locations:

  • proto/cosmos/app/v1alpha1/query.proto: rpc Config(QueryConfigRequest) returns (QueryConfigResponse) {
  • proto/cosmos/app/v1alpha1/query.proto:// QueryConfigRequest is the Query/Config request type.
  • proto/cosmos/app/v1alpha1/query.proto:message QueryConfigRequest {}

Please update these occurrences to ensure consistency.

Analysis chain

Renaming of QueryConfigRequest to QueryConfigResponse correctly reflects its usage as a response type.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that all occurrences of the old type name `QueryConfigRequest` have been updated.

# Test: Search for the old type name. Expect: No occurrences of the old type name.
rg --type proto "QueryConfigRequest"

Length of output: 66

Script:

#!/bin/bash
# Description: Verify that all occurrences of the old type name `QueryConfigRequest` have been updated.

# Test: Search for the old type name in .proto files. Expect: No occurrences of the old type name.
rg "QueryConfigRequest" --glob "*.proto"

Length of output: 305

message QueryConfigResponse {

// config is the current app config.
Expand Down
2 changes: 1 addition & 1 deletion x/staking/proto/cosmos/staking/v1beta1/staking.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ message HistoricalInfo {
repeated Validator valset = 2 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
}

// Historical contains a set of minimum values needed for evaluating historical validator sets and blocks.
// HistoricalRecord contains a set of minimum values needed for evaluating historical validator sets and blocks.
// It is stored as part of staking module's state, which persists the `n` most
// recent HistoricalInfo
// (`n` is set by the staking module's `historical_entries` parameter).
Expand Down
2 changes: 1 addition & 1 deletion x/staking/types/staking.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading