docs(x/circuit): fix circuit command examples

[tutufen]

Description

This PR fixes the examples of x/circuit tx subcommands

Summary by CodeRabbit

• New Features
  • Updated command usage examples for several RPC methods to reflect a new execution format.
    • Changed command prefix from "circuit" to "tx" for AuthorizeCircuitBreaker, TripCircuitBreaker, and ResetCircuitBreaker.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request involve updates to the command examples within the AutoCLIOptions method of the AppModule struct in the x/circuit/autocli.go file. The prefix "circuit" has been replaced with "tx" for the example strings related to the AuthorizeCircuitBreaker, TripCircuitBreaker, and ResetCircuitBreaker commands. This modification reflects a new command usage format while maintaining the overall structure of the command descriptors.

Changes

File	Change Summary
x/circuit/autocli.go	Updated command example strings for AuthorizeCircuitBreaker, TripCircuitBreaker, and ResetCircuitBreaker to replace "circuit" with "tx".

Possibly related PRs

• docs(x/circuit): display correct example #21768: This PR modifies example command strings in the same AutoCLIOptions function of the AppModule struct in x/circuit/autocli.go, making it directly related to the changes in the main PR regarding command example formatting.

Suggested labels

backport/v0.50.x, backport/v0.52.x

Suggested reviewers

• kocubinski
• raynaudoe
• akhilkumarpilli
• sontrinh16

---

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c5889a4 and a3915c0.

📒 Files selected for processing (1)

• x/circuit/autocli.go (3 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

x/circuit/autocli.go (1)

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

🔇 Additional comments (4)

x/circuit/autocli.go (4)

46-46: Improved command example for AuthorizeCircuitBreaker

The change from circuit authorize to tx circuit authorize in the example command is correct and aligns with the typical Cosmos SDK transaction command structure. This improvement enhances the accuracy of the documentation and provides a better guide for users.

---

56-56: Consistent improvement in TripCircuitBreaker command example

The modification from circuit disable to tx circuit disable in the example command is correct and consistent with the previous change. This update maintains uniformity across the command examples and accurately reflects the proper usage of the circuit breaker functionality.

---

65-65: Completed set of improvements for circuit breaker command examples

The change from circuit reset to tx circuit reset in the example command is correct and completes the set of improvements for all circuit breaker command examples in this file. These consistent updates across all commands enhance the overall accuracy and usability of the documentation.

---

Line range hint 46-65: Overall improvement in circuit command examples

The changes made to the command examples in this file consistently replace "circuit" with "tx circuit" for the AuthorizeCircuitBreaker, TripCircuitBreaker, and ResetCircuitBreaker commands. These updates:

1. Align with the typical Cosmos SDK transaction command structure.
2. Improve the accuracy of the documentation.
3. Provide better guidance for users interacting with the circuit breaker functionality.

The modifications successfully address the PR objective of fixing the circuit command examples, enhancing the overall quality and usability of the documentation.

---

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

[tac0turtle]

thank you