]> Untitled Git - bdk-cli/commitdiff
Merge bitcoindevkit/bdk-cli#69: Fix repl and wallet help docs
authorSteve Myers <steve@notmandatory.org>
Sat, 12 Feb 2022 06:23:42 +0000 (22:23 -0800)
committerSteve Myers <steve@notmandatory.org>
Sat, 12 Feb 2022 06:24:41 +0000 (22:24 -0800)
3f9b89275b0fce9ceaa3b113e3832d5e28f7d688 Pin fd-lock version to 3.0.2 (Steve Myers)
4a02a9f3838fedac832bc73d19d086abfb881688 Manual docs formatting fix (Steve Myers)
c82fd90f0b7eaaec60ffe0cf686a4bf11ab9707d Update Cargo.lock (Steve Myers)
81652b19d1d9d36964dc2ac22831950b02897338 Fix repl and wallet help docs (Steve Myers)

Pull request description:

  ### 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 https://github.com/TeXitoi/structopt/issues/333#issuecomment-712265332

  ### Notes to the reviewers

  Before this PR this was showing:
  ```shell
  $ 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:
  ```shell
  $ 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:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk-cli/blob/master/CONTRIBUTING.md)
  * [x] 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

Top commit has no ACKs.

Tree-SHA512: 8d708720f60940edd40826a159388ced261c91d23e074b51164f8c49a2e673cbaecee0241e52cb02090e40ff1f989a980aee0122230cee211f4c3284cad4483c


Trivial merge