feat(cli): drop redundant 'wormhole send/receive' lines from --help#355
Open
mvanhorn wants to merge 1 commit intomagic-wormhole:mainfrom
Open
feat(cli): drop redundant 'wormhole send/receive' lines from --help#355mvanhorn wants to merge 1 commit intomagic-wormhole:mainfrom
mvanhorn wants to merge 1 commit intomagic-wormhole:mainfrom
Conversation
The default binary name is 'wormhole-rs', not 'wormhole', so the two example lines in the after-help output are technically wrong. They are also redundant - the per-subcommand --help already documents send and receive. Drop them as suggested by @felinira in magic-wormhole#209. Updates the trycmd snapshots in cli/tests/cmd/help.stdout and basic.stderr to match. Closes magic-wormhole#209
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #355 +/- ##
==========================================
+ Coverage 39.36% 39.39% +0.03%
==========================================
Files 20 20
Lines 3292 3292
==========================================
+ Hits 1296 1297 +1
+ Misses 1996 1995 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The default binary name is
wormhole-rs, but the--helpafter-help text referenceswormhole sendandwormhole receive:So the example commands don't match what users actually type. Per @felinira's comment on #209, the cleanest fix is to drop the last two lines - the per-subcommand
wormhole-rs send --help/receive --helpalready documents what those subcommands need.Changes:
cli/src/main.rs:253-255: keep onlyRun a subcommand with --help to know how it's used.inafter_help.cli/tests/cmd/help.stdoutandcli/tests/cmd/basic.stderr: drop the two corresponding lines from the trycmd snapshots.Verified locally:
All 9 trycmd cases pass.
Closes #209.
This contribution was developed with AI assistance (Claude Code).