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

Fix repl and wallet help docs #69

Merged
merged 4 commits into from
Feb 12, 2022

Conversation

notmandatory
Copy link
Member

@notmandatory notmandatory commented Jan 9, 2022

Description

This fixes the help docs for the repl and wallet subcommands. The repl subcommand was showing the proxy options docs instead, and the wallet subcommand was showing the description from the WalletSubCommand enum.

This is a workaround for structopt issue #333, #391, #418; see TeXitoi/structopt#333 (comment)

Notes to the reviewers

Before this PR this was showing:

$ cargo run --features esplora-ureq,compiler -- --help
...
SUBCOMMANDS:
    compile    Compile a miniscript policy to an output descriptor
    help       Prints this message or the help of the given subcommand(s)
    key        Key management sub-commands
    repl       Proxy Server options
    wallet     Wallet sub-commands

After this PR we get:

$ cargo run --features esplora-ureq,compiler -- --help
...
SUBCOMMANDS:
    compile    Compile a miniscript policy to an output descriptor
    help       Prints this message or the help of the given subcommand(s)
    key        Key management sub-commands
    repl       Enter REPL command loop mode
    wallet     Wallet options and sub-commands

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

@notmandatory notmandatory changed the title Fix/repl docs Fix repl and wallet help docs Jan 9, 2022
@notmandatory notmandatory force-pushed the fix/repl_docs branch 2 times, most recently from f2e734f to 2023475 Compare January 9, 2022 22:28
@notmandatory notmandatory added good first issue Good for newcomers and removed good first issue Good for newcomers labels Feb 1, 2022
@notmandatory notmandatory self-assigned this Feb 1, 2022
Copy link
Contributor

@rajarshimaitra rajarshimaitra left a comment

Choose a reason for hiding this comment

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

Concept + tACK 2023475

Needs a rebase..

This fixes the help docs for the repl and wallet subcommands. The repl subcommand was showing the proxy options docs instead, and the wallet subcommand was showing the description from the WalletSubCommand enum.
This is a workaround for structopt issue #333, #391, #418.
see TeXitoi/structopt#333 (comment)
@notmandatory
Copy link
Member Author

notmandatory commented Feb 11, 2022

I also had to pin the version of fd-lock to version 3.0.2 to resolve an error when building with rust +1.46.0.

@notmandatory notmandatory merged commit 8ba5da7 into bitcoindevkit:master Feb 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants