Skip to content

Commit

Permalink
improve wording in ICQ module doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
sotnikov-s committed Nov 27, 2024
1 parent eb2ec60 commit 95ce534
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 12 deletions.
4 changes: 2 additions & 2 deletions proto/neutron/interchainqueries/genesis.proto
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ message RegisteredQuery {
(gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
(gogoproto.nullable) = false
];
// Duration in blocks that is required to pass since the query registration/update for the
// query to become available for anybody to be removed.
// The duration, measured in blocks, that must pass since the query's registration or its last
// result submission before the query becomes eligible for removal by anyone.
uint64 submit_timeout = 11;
// The local chain block height of the Interchain Query registration.
uint64 registered_at_height = 12;
Expand Down
5 changes: 3 additions & 2 deletions proto/neutron/interchainqueries/params.proto
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ option go_package = "github.com/neutron-org/neutron/v5/x/interchainqueries/types
// The parameters for the module.
message Params {
option (gogoproto.goproto_stringer) = false;
// The amount of blocks required to pass since an Interchain Query registration/update for the
// query to become available for removal by anybody.
// The duration, measured in blocks, that must pass since the query's registration or its last
// result submission before the query becomes eligible for removal by anyone. Is used to set
// `submit_timeout` on Interchain Query registration.
uint64 query_submit_timeout = 1;
// Amount of coins required to be provided as deposit on Interchain Query registration.
repeated cosmos.base.v1beta1.Coin query_deposit = 2 [
Expand Down
2 changes: 1 addition & 1 deletion proto/neutron/interchainqueries/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ message QueryParamsRequest {}

// Response type for the Query/Params RPC method.
message QueryParamsResponse {
// Stores all parameters of the module.
// Contains all parameters of the module.
Params params = 1 [(gogoproto.nullable) = false];
}

Expand Down
3 changes: 2 additions & 1 deletion proto/neutron/interchainqueries/tx.proto
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,8 @@ message StorageValue {
bytes key = 2;
// A base64-encoded value read from the given storage path.
bytes value = 3;
// The Merkle Proof which proves existence of key-value pair in IAVL storage. Is used to verify
// The Merkle Proof which proves existence/nonexistence of key-value pair in IAVL storage. Is
// used to verify
// the pair against the respective remote chain's header.
tendermint.crypto.ProofOps Proof = 4;
}
Expand Down
4 changes: 2 additions & 2 deletions x/interchainqueries/types/genesis.pb.go

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

5 changes: 3 additions & 2 deletions x/interchainqueries/types/params.pb.go

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

2 changes: 1 addition & 1 deletion x/interchainqueries/types/query.pb.go

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

3 changes: 2 additions & 1 deletion x/interchainqueries/types/tx.pb.go

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

0 comments on commit 95ce534

Please sign in to comment.