docs: updates Example, Use auctocli

[DongLieu]

Description

Closes: #XXXX

---

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

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

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

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features

  • Updated command usage for querying distribution rewards to specify "rewards-by-validator".
  • Added a new command-line option for querying all validators in the CLI.

• Bug Fixes

  • Corrected command syntax for better clarity in user instructions.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces two minor modifications to the autocli configuration in the distribution and staking modules. In the distribution module, the example command for delegation rewards is updated to use a more specific command name "rewards-by-validator". In the staking module, a new "Use" field is added to the validators RPC command options, providing a clearer command-line interface for querying validators.

Changes

File	Change Summary
x/distribution/autocli.go	Updated Example field for delegation rewards command from "rewards" to "rewards-by-validator"
x/staking/autocli.go	Added Use: "validators" to RpcCommandOptions for Validators RPC method

Possibly related PRs

• docs(x/gov): Sync Example with Use in autocli #22768: Modifies AutoCLIOptions method in x/distribution/autocli.go, updating the Example field for a command descriptor

Suggested labels

C:x/distribution, C:x/auth

Suggested reviewers

• alpe
• JulianToledano
• sontrinh16
• hieuvubk
• testinginprod
• aaronc
• kocubinski

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

x/distribution/autocli.go (1)

66-66: Consider rephrasing for clarity in usage instructions.
Currently, the short description reads: “Query all distribution delegator from a particular validator,” which can be ambiguous. A clearer phrasing might be “Query distribution rewards from a particular validator for a given delegator.”

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ef2f8d and c9f6176.

📒 Files selected for processing (2)

• x/distribution/autocli.go (1 hunks)
• x/staking/autocli.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

x/staking/autocli.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

x/distribution/autocli.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (1)

x/staking/autocli.go (1)

20-20: LGTM.
Adding "validators" to the Use field improves clarity and consistency, matching established CLI naming patterns.

[hieuvubk]

lgtm!

[julienrbrt]

@Mergifyio backport release/v0.52.x

[mergify]

backport release/v0.52.x

✅ Backports have been created

• #23113 docs: updates Example, Use auctocli (backport #23088) has been created for branch release/v0.52.x