From 5c37fe6733e10370425ac9dd25aada16eacaeb58 Mon Sep 17 00:00:00 2001 From: Thomas Eizinger Date: Wed, 7 Jul 2021 14:17:57 +1000 Subject: [PATCH] Make struct-opt docs more consistent - Remove dots from the of help messages - Unify wording --- swap/src/bin/swap.rs | 6 +++--- swap/src/cli/command.rs | 23 ++++++++++++----------- 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/swap/src/bin/swap.rs b/swap/src/bin/swap.rs index 5c8d487a..5c39af1d 100644 --- a/swap/src/bin/swap.rs +++ b/swap/src/bin/swap.rs @@ -272,11 +272,11 @@ async fn main() -> Result<()> { cli::refund(swap_id, Arc::new(bitcoin_wallet), db, force).await??; } Command::ListSellers { - rendezvous_node_addr, + rendezvous_point, namespace, tor_socks5_port, } => { - let rendezvous_node_peer_id = rendezvous_node_addr + let rendezvous_node_peer_id = rendezvous_point .extract_peer_id() .context("Rendezvous node address must contain peer ID")?; @@ -287,7 +287,7 @@ async fn main() -> Result<()> { let mut sellers = list_sellers( rendezvous_node_peer_id, - rendezvous_node_addr, + rendezvous_point, namespace, tor_socks5_port, identity, diff --git a/swap/src/cli/command.rs b/swap/src/cli/command.rs index d9422ab1..b97faf1d 100644 --- a/swap/src/cli/command.rs +++ b/swap/src/cli/command.rs @@ -188,7 +188,7 @@ where }, }, RawCommand::ListSellers { - rendezvous_node_addr, + rendezvous_point, tor: Tor { tor_socks5_port }, } => Arguments { env_config: env_config_from(is_testnet), @@ -196,7 +196,7 @@ where json, data_dir: data::data_dir_from(data, is_testnet)?, cmd: Command::ListSellers { - rendezvous_node_addr, + rendezvous_point, namespace: rendezvous_namespace_from(is_testnet), tor_socks5_port, }, @@ -238,7 +238,7 @@ pub enum Command { bitcoin_target_block: usize, }, ListSellers { - rendezvous_node_addr: Multiaddr, + rendezvous_point: Multiaddr, namespace: XmrBtcNamespace, tor_socks5_port: u16, }, @@ -261,13 +261,13 @@ struct RawArguments { )] data: Option, - #[structopt(long, help = "Activate debug logging.")] + #[structopt(long, help = "Activate debug logging")] debug: bool, #[structopt( short, long = "json", - help = "Changes the log messages to json vs plain-text. This can be helpful to simplify automated log analyses." + help = "Outputs all logs in JSON format instead of plain text" )] json: bool, @@ -277,7 +277,7 @@ struct RawArguments { #[derive(structopt::StructOpt, Debug)] enum RawCommand { - /// Start a XMR for BTC swap + /// Start a BTC for XMR swap BuyXmr { #[structopt(flatten)] seller: Seller, @@ -303,7 +303,7 @@ enum RawCommand { #[structopt(flatten)] tor: Tor, }, - /// Show a list of past ongoing and completed swaps + /// Show a list of past, ongoing and completed swaps History, /// Resume a swap Resume { @@ -330,7 +330,7 @@ enum RawCommand { #[structopt(flatten)] bitcoin: Bitcoin, }, - /// Try to cancel a swap and refund my BTC (expert users only) + /// Try to cancel a swap and refund the BTC (expert users only) Refund { #[structopt(flatten)] swap_id: SwapId, @@ -341,13 +341,14 @@ enum RawCommand { #[structopt(flatten)] bitcoin: Bitcoin, }, + /// Discover and list sellers (i.e. ASB providers) ListSellers { #[structopt( long, - help = "The multiaddr (including peer-id) of a rendezvous node that sellers register with", + help = "Address of the rendezvous point you want to use to discover ASBs", default_value = DEFAULT_RENDEZVOUS_ADDRESS )] - rendezvous_node_addr: Multiaddr, + rendezvous_point: Multiaddr, #[structopt(flatten)] tor: Tor, @@ -370,7 +371,7 @@ struct Bitcoin { #[structopt( long = "bitcoin-target-block", - help = "Use for fee estimation, decides within how many blocks the Bitcoin transactions should be confirmed." + help = "Estimate Bitcoin fees such that transactions are confirmed within the specified number of blocks" )] bitcoin_target_block: Option, }