Cleanup cli help messages

bitcoindevkit · Feb 3, 2021 · e92fcaa · e92fcaa
1 parent a64086e
commit e92fcaa
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/src/bdk_cli.rs b/src/bdk_cli.rs
@@ -55,7 +55,7 @@ use regex::Regex;
 version = option_env ! ("CARGO_PKG_VERSION").unwrap_or("unknown"),
 author = option_env ! ("CARGO_PKG_AUTHORS").unwrap_or(""))]
 struct ReplOpt {
-    /// Wallet sub-command
+    /// Repl sub-command
     #[structopt(subcommand)]
     pub subcommand: ReplSubCommand,
 }

diff --git a/src/lib.rs b/src/lib.rs
@@ -189,27 +189,32 @@ pub struct CliOpts {
 
 /// CLI sub-commands
 ///
-/// The top level mode for subsequent sub-commands, each may have different required options. For
+/// The top level sub-commands, each may have different required options. For
 /// instance [`CliSubCommand::Wallet`] requires [`WalletOpts`] with a required descriptor but
 /// [`CliSubCommand::Key`] sub-command does not. [`CliSubCommand::Repl`] also requires
 /// [`WalletOpts`] and a descriptor because in this mode both [`WalletSubCommand`] and
 /// [`KeySubCommand`] sub-commands are available.
 ///
 #[derive(Debug, StructOpt, Clone, PartialEq)]
+#[structopt(rename_all = "snake",
+long_about = "Top level options and command modes")]
 pub enum CliSubCommand {
     /// Wallet options and sub-commands
+    #[structopt(long_about = "Wallet mode")]
     Wallet {
         #[structopt(flatten)]
         wallet_opts: WalletOpts,
         #[structopt(subcommand)]
         subcommand: WalletSubCommand,
     },
     /// Key management sub-commands
+    #[structopt(long_about = "Key management mode")]
     Key {
         #[structopt(subcommand)]
         subcommand: KeySubCommand,
     },
     /// Enter REPL command loop mode
+    #[structopt(long_about = "REPL command loop mode")]
     Repl {
         #[structopt(flatten)]
         wallet_opts: WalletOpts,