style: Fix gov query proposals examples syntax

[Lefey]

Fix gov query proposals examples syntax

Description

After #16987 proposal status flag have renamed from --status to --proposal-status but help command gov query proposals --help show usage examples that have confusing values that can be used with --proposal-status flag, this pull request fix this typo in /x/gov/autocli.go

---

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

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

• Documentation
  • Enhanced descriptions for --proposal-status options in the command-line interface.

[coderabbitai]

Walkthrough

Walkthrough

The recent modification enhances the AutoCLIOptions function within the am module by updating the Example field. This update focuses on providing more descriptive options for the --proposal-status parameter, aiming to improve user understanding and interaction with the command-line interface.

Changes

File Path	Change Summary
x/gov/autocli.go	Updated Example field in AutoCLIOptions to enhance descriptions for --proposal-status.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0c91044 and dc36f12.

Files selected for processing (1)

• x/gov/autocli.go (1 hunks)

Additional Context Used

Path-based Instructions (1)

x/gov/autocli.go (1)

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

Additional comments not posted (1)

x/gov/autocli.go (1)

35-35: Update the command-line examples to reflect the correct flag usage.

Ensure that the examples provided are accurate and test them to confirm they work as expected. This is crucial since command-line examples are often used directly by end-users.

Verification successful

---

The command-line examples in the Proposals RPC method are correctly using version.AppName as a placeholder for the application name, which is dynamically set during the build process. The inability to execute these commands directly in the shell script is expected because shell environments do not have access to Go build-time variables. This is not an error in the codebase but a limitation of the testing environment used in the script.

• Ensure that the build process correctly sets version.AppName as expected.
• When testing these commands manually, replace version.AppName with the actual application name.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify the correctness of the command-line examples in the `Proposals` RPC method.

# Test: Execute the examples and check for any errors.
echo "Testing command-line examples for correctness..."
echo "Example 1: $(version.AppName) query gov proposals --depositor cosmos1..."
echo "Example 2: $(version.AppName) query gov proposals --voter cosmos1..."
echo "Example 3: $(version.AppName) query gov proposals --proposal-status (unspecified | deposit-period | voting-period | passed | rejected | failed)"

Length of output: 903

---

---

Script:

#!/bin/bash
# Description: Search for the definition and usage of `version.AppName` in the codebase.

# Use rg to search for the pattern 'version.AppName' across all files.
rg "version.AppName"

Length of output: 15718

[julienrbrt]

Thank you!