feat: refactor ICQ module documentation [NTRN-349] #646
+1,205
−543
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
…tor-icq-module-documentation
sotnikov-s
force-pushed
the
feat/refactor-icq-module-documentation
branch
from
852a6ae to
f591f09
Compare
sotnikov-s
force-pushed
the
feat/refactor-icq-module-documentation
branch
from
5203ec0 to
ecdff56
Compare
sotnikov-s
force-pushed
the
feat/refactor-icq-module-documentation
branch
2 times, most recently
from
8851318 to
05acc43
Compare
sotnikov-s
force-pushed
the
feat/refactor-icq-module-documentation
branch
from
05acc43 to
c5b2703
Compare
…tor-icq-module-documentation
NeverHappened
previously approved these changes
Nov 22, 2024
swelf19
reviewed
Nov 22, 2024
| ]; | ||
|
|
||
| // Timeout before query becomes available for everybody to remove. | ||
| // Duration in blocks that is required to pass since the query registration/update for the |
There was a problem hiding this comment.
What the 'update' word means here. How to keep query alive
There was a problem hiding this comment.
yeah, that's a good catch. especially given the ambiguity behind the 'update' term which in the API means the query parameters update. will fix
| // removal by anybody | ||
| // The amount of blocks required to pass since an Interchain Query registration/update for the | ||
| // query to become available for removal by anybody. | ||
| uint64 query_submit_timeout = 1; |
There was a problem hiding this comment.
How is this param related to submit_timeout of an interchain query
There was a problem hiding this comment.
will rephrase, too
| // Response type for the Query/Params RPC method. | ||
| message QueryParamsResponse { | ||
| // params holds all the parameters of this module. | ||
| // Stores all parameters of the module. |
There was a problem hiding this comment.
Is the stores word correct for this certain usecase?
|
|
||
| // is the Merkle Proof which proves existence of key-value pair in IAVL | ||
| // storage | ||
| // The Merkle Proof which proves existence of key-value pair in IAVL storage. Is used to verify |
There was a problem hiding this comment.
Or proves nonexistance if no key-value pair in IAVL storage, not sure is it obvious from the comment.
pr0n00gler
reviewed
Nov 28, 2024
pr0n00gler
reviewed
Nov 28, 2024
pr0n00gler
reviewed
Nov 28, 2024
pr0n00gler
requested changes
Nov 28, 2024
pr0n00gler
previously approved these changes
Nov 28, 2024
NeverHappened
previously approved these changes
Nov 29, 2024
sotnikov-s
dismissed stale reviews from NeverHappened and pr0n00gler
via
dd24540
pr0n00gler
approved these changes
Nov 29, 2024
NeverHappened
approved these changes
Nov 29, 2024
joldie777
approved these changes
Nov 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
task
https://hadronlabs.atlassian.net/browse/NTRN-349
this PR
.protoandsudodefinitions of theinterchainqueriesmodule with comments aiming to make use of the descriptions via links to code based documentation (e.g. QueryRegisteredQueriesRequest)related PRs