[#141] Add docstring to the '--proxy' CLI flag (#142)

Resolves #141 ### Additional tasks - [ ] Documentation for changes provided/changed - [ ] Tests added - [ ] Updated CHANGELOG.md Co-authored-by: Dmitrii Kovanikov <[email protected]>
chshersh · Oct 21, 2022 · a64ab97 · a64ab97
1 parent f9b71cf
commit a64ab97
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/config/cli.rs b/src/config/cli.rs
@@ -5,10 +5,11 @@ use clap::{Parser, Subcommand};
 #[derive(Parser, Debug)]
 #[command(author="Dmitrii Kovanikov <[email protected]>", version, about="A CLI tool to manage other CLI tools", long_about = None)]
 pub struct Cli {
- /// Sets a path to a configuration file (default: $HOME/.tool.toml)
+ /// Set a path to a configuration file (default: $HOME/.tool.toml)
  #[arg(short, long, value_name = "FILE")]
  pub config: Option<PathBuf>,
 
+ /// Use with a custom proxy like this: `tool --proxy=http://127.0.0.1:8080 sync`
  #[arg(short, long, value_name = "uri")]
  pub proxy: Option<String>,