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

adjust cmd class help parameters #18921

Merged
merged 1 commit into from
Nov 22, 2024
Merged

adjust cmd class help parameters #18921

merged 1 commit into from
Nov 22, 2024

Conversation

altendky
Copy link
Contributor

@altendky altendky commented Nov 22, 2024

Purpose:

presently you are only able to specify the click short help message for cmd classes. this short help is used when you checking --help on the group containing the command. this pr renames the exisitng parameter to short_help and adds a new parameter help (reusing the existing parameter name). the help parameter specifies the text used when you do --help on the command itself. both are required parameters.

Current Behavior:

New Behavior:

Testing Notes:

@altendky altendky requested a review from a team as a code owner November 22, 2024 00:33
@altendky altendky added Changed Required label for PR that categorizes merge commit message as "Changed" for changelog Exclude_Notes Use this label if the changes in the PR should be excluded from the release notes labels Nov 22, 2024
Copy link

Pull Request Test Coverage Report for Build 11964139834

Details

  • 32 of 32 (100.0%) changed or added relevant lines in 4 files are covered.
  • 15 unchanged lines in 9 files lost coverage.
  • Overall coverage decreased (-0.003%) to 91.186%

Files with Coverage Reduction New Missed Lines %
chia/daemon/keychain_proxy.py 1 73.16%
chia/farmer/farmer.py 1 72.52%
chia/server/node_discovery.py 1 79.45%
chia/daemon/client.py 1 74.01%
chia/daemon/server.py 1 83.22%
chia/wallet/wallet_node.py 1 88.33%
chia/full_node/full_node.py 1 86.06%
chia/rpc/rpc_server.py 4 88.2%
chia/full_node/weight_proof.py 4 90.48%
Totals Coverage Status
Change from base Build 11962414890: -0.003%
Covered Lines: 103404
Relevant Lines: 113203

💛 - Coveralls

@Starttoaster Starttoaster merged commit 30a83ce into main Nov 22, 2024
364 checks passed
@Starttoaster Starttoaster deleted the cmd_class_help branch November 22, 2024 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changed Required label for PR that categorizes merge commit message as "Changed" for changelog Exclude_Notes Use this label if the changes in the PR should be excluded from the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants