docs: Update tendermint validators query pagination documentation #22412
Conversation
|
Caution Review failedThe pull request is closed. 📝 Walkthrough📝 WalkthroughWalkthroughThe changes in this pull request focus on the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
proto/cosmos/base/tendermint/v1beta1/query.proto (1)
62-63: Documentation improvements address pagination issues effectivelyThe added clarification about
next_keynot being supported is valuable and directly addresses the pagination issues mentioned in #21961. However, consider enhancing the documentation further to:
- Explain why
next_keyis not supported- Document the expected behavior of
countTotal- Provide example queries showing correct usage
Consider adding more detailed documentation:
- // pagination defines an pagination for the request. offset and limit are used for pagination, next_key is not supported for this query. + // pagination defines an pagination for the request. + // - offset and limit are used for pagination + // - next_key is not supported due to the deterministic nature of validator set queries + // - count_total returns the total number of validatorsAlso applies to: 70-71, 84-85
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
proto/cosmos/base/tendermint/v1beta1/query.proto(7 hunks)
🧰 Additional context used
🪛 buf
proto/cosmos/base/tendermint/v1beta1/query.proto
4-4: import "amino/amino.proto": file does not exist
(COMPILE)
🔇 Additional comments (3)
proto/cosmos/base/tendermint/v1beta1/query.proto (3)
54-56: LGTM: Service definition formatting changes
The formatting changes to the ABCIQuery service definition maintain the same functionality while improving readability.
90-93: LGTM: Consistent message field formatting
The formatting changes across multiple message definitions improve code consistency while maintaining the same functionality.
Also applies to: 137-138, 143-150, 165-168, 179-183, 186-187, 198-200, 207-211
4-4: Verify the existence of amino/amino.proto import
The static analysis indicates that the amino/amino.proto file doesn't exist, which could cause compilation issues.
✅ Verification successful
Import path for amino/amino.proto is valid
The amino/amino.proto file exists at proto/amino/amino.proto, confirming that the import statement is correct and will not cause compilation issues.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the amino.proto file exists in the proto directory
fd -t f "amino.proto" proto/
Length of output: 52
🧰 Tools
🪛 buf
4-4: import "amino/amino.proto": file does not exist
(COMPILE)
julienrbrt
added
the
backport/v0.52.x
…2412) Co-authored-by: Julien Robert <[email protected]> (cherry picked from commit d0d8585) # Conflicts: # api/cosmos/base/tendermint/v1beta1/query.pulsar.go
…ckport #22412) (#22439) Co-authored-by: Eric Mokaya <[email protected]> Co-authored-by: marbar3778 <[email protected]>
* main: (24 commits) build(deps): upgrade to [email protected] (#22436) docs: Update tendermint validators query pagination documentation (#22412) refactor(client/v2): offchain uses client/v2/factory (#22344) feat: wire new handlers to grpc (#22333) fix(x/group): proper address rendering in error (#22425) refactor(serevr/v2/cometbft): update `RegisterQueryHandlers` and GRPC queries (#22403) docs: update ADR 59 (#22423) build(deps): Bump github.com/fsnotify/fsnotify from 1.7.0 to 1.8.0 in /tools/cosmovisor (#22407) docs: Module account address documentation (#22289) feat(baseapp): add per message telemetry (#22175) docs: Update Twitter Links to X in Documentation (#22408) docs: redirect the remote generation page (#22404) refactor(serverv2): remove unused interface methods, honuor context (#22394) fix(server/v2): return ErrHelp (#22399) feat(indexer): implement `schema.HasModuleCodec` interface in the `bank` module (#22349) refactor(math): refactor ApproxRoot for readality (#22263) docs: fix KWallet Handbook (#22395) feat(client/v2): broadcast logic (#22282) refactor(server/v2): eager config loading (#22267) test(system): check feePayers signature (#22389) ...
Description
Closes: #21961
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
Documentation
Chores
next_keyis not supported.