Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve align cli help #18179

Merged
merged 2 commits into from
Oct 20, 2023
Merged

chore: improve align cli help #18179

merged 2 commits into from
Oct 20, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Oct 19, 2023

Description

chores that remove unused variable and align bank help:
image
currently looking as above.


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
  • added ! to 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
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • 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 ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • Documentation: Improved the readability and clarity of help messages and command descriptions across multiple modules, including x/auth/vesting, x/bank, x/circuit, x/group, and x/staking. These changes will make it easier for users to understand the purpose and usage of various commands.
  • Refactor: Removed unused global variables FlagCommission and FlagMaxMessagesPerTx from the x/distribution module, simplifying the codebase without affecting functionality.
  • Style: Adjusted text formatting and indentation in several modules, enhancing the overall user experience by making the command-line interface more user-friendly.

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Oct 19, 2023
@julienrbrt julienrbrt requested a review from a team as a code owner October 19, 2023 16:42
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 19, 2023

Walkthrough

This pull request primarily focuses on improving the readability and maintainability of the code by refining the formatting and descriptions of various CLI commands across multiple modules. It also includes the removal of unused global variables and unnecessary package imports.

Changes

File(s) Summary
x/auth/vesting/autocli.go, x/bank/autocli.go, x/circuit/autocli.go, x/group/module/autocli.go, x/staking/autocli.go Improved the formatting and readability of the Long field of various CLI commands.
x/distribution/autocli.go Removed two unused global variables FlagCommission and FlagMaxMessagesPerTx.
x/feegrant/module/autocli.go Removed the import of the "strings" package and updated the "Long" field of the "grant" command.

"In the land of code, where the shadows lie,

A rabbit hopped, with a twinkle in its eye. 🐇✨

With each hop, a change was made,

Cleaning up the mess that time had laid. 🧹🕰️

Now the code is neat, and the rabbit is done,

Ready for the next hop, the next bit of fun!" 🎉🐾


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • Mention @coderabbitai in any review comment for bot assistance.
  • Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

  • Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.
  • Additionally, enter @coderabbitai pause to halt the bot's ongoing reviews as any issue or review comment. To
    resume reviews, enter @coderabbitai resume as any issue or review comment.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 67fbfcd and 5ef389c.
Files selected for processing (7)
  • x/auth/vesting/autocli.go (1 hunks)
  • x/bank/autocli.go (2 hunks)
  • x/circuit/autocli.go (1 hunks)
  • x/distribution/autocli.go (1 hunks)
  • x/feegrant/module/autocli.go (2 hunks)
  • x/group/module/autocli.go (1 hunks)
  • x/staking/autocli.go (1 hunks)
Files skipped from review due to trivial changes (7)
  • x/auth/vesting/autocli.go
  • x/bank/autocli.go
  • x/circuit/autocli.go
  • x/distribution/autocli.go
  • x/feegrant/module/autocli.go
  • x/group/module/autocli.go
  • x/staking/autocli.go

@julienrbrt julienrbrt changed the title chore: improve align autocli bank help chore: improve align cli help Oct 19, 2023
@julienrbrt julienrbrt added this pull request to the merge queue Oct 20, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 20, 2023
@julienrbrt julienrbrt added this pull request to the merge queue Oct 20, 2023
Merged via the queue into main with commit 7421783 Oct 20, 2023
58 checks passed
@julienrbrt julienrbrt deleted the julien/chores branch October 20, 2023 10:31
mergify bot pushed a commit that referenced this pull request Oct 20, 2023
julienrbrt added a commit that referenced this pull request Oct 20, 2023
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:x/auth C:x/bank C:x/circuit C:x/distribution distribution module related C:x/feegrant C:x/group C:x/staking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants