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

Improve help text for deprecated 'chia show' commands. #15297

Merged
merged 1 commit into from May 16, 2023

Conversation

notpeter
Copy link
Contributor

Purpose:

Improve help text provided by deprecated chia show commands.
Current text suggests running a command which also results in error.
We should suggest a command equivalent to the deprecated command the user ran.

Current Behavior:

$ chia show -c
'chia show -c' has been renamed to 'chia peer -c' 
$ chia peer -c
Usage: chia peer [OPTIONS]
                 {farmer|wallet|full_node|harvester|data_layer|simulator}
Try 'chia peer -h' for help.

Error: Missing argument '{farmer|wallet|full_node|harvester|data_layer|simulator}'. Choose from:
	farmer,
	wallet,
	full_node,
	harvester,
	data_layer,
	simulator

New Behavior:

$ chia show -c
'chia show -c' has been renamed to 'chia peer full_node -c' 
$ chia peer full_node -c
<...snip...command works...>

Testing Notes:

@notpeter notpeter requested a review from a team as a code owner May 16, 2023 13:33
@arvidn arvidn added the Changed Required label for PR that categorizes merge commit message as "Changed" for changelog label May 16, 2023
@arvidn
Copy link
Contributor

arvidn commented May 16, 2023

@notpeter hey, would it be possible for you to sign your commit and force-push it?

@notpeter
Copy link
Contributor Author

notpeter commented May 16, 2023

@notpeter hey, would it be possible for you to sign your commit and force-push it?

Done. That check is passing now. I'd suggest y'all update CONTRIBUTING.md to document this policy.

@wallentx wallentx merged commit c8c04f6 into Chia-Network:main May 16, 2023
194 of 195 checks passed
@notpeter notpeter deleted the chia_show_helpfix branch May 22, 2023 20:21
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants