Missing docstring on proxy flag

[MitchellBerend]

tool-sync/src/config/schema.rs

Lines 13 to 21 in 5d1a6b6

	#[derive(Debug, PartialEq, Eq)]
	pub struct Config {
	/// Directory to store all locally downloaded tools
	pub store_directory: String,
	pub proxy: Option<String>,
	/// Info about each individual tool
	pub tools: BTreeMap<String, ConfigAsset>,
	}

tool-sync/src/config/cli.rs

Lines 5 to 17 in 5d1a6b6

	#[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)
	#[arg(short, long, value_name = "FILE")]
	pub config: Option<PathBuf>,
	#[arg(short, long, value_name = "uri")]
	pub proxy: Option<String>,
	#[command(subcommand)]
	pub command: Command,
	}

The person who implemented this flag (me) forgot to add a doc strings to explain how to use this and what it does.
This option takes a proxy that can be understood by the ureq Proxy struct.

[jim4067]

let me look into this

[MitchellBerend]

Sure go ahead. I'm not sure what the doc string on this should be to be honest. I only know how to make the proxy work with my own set up.

The original issue is #82 and the pr is #121

[chshersh]

I would simply add a usage example, e.g.:

You can custom proxy in tool-sync like this:

tool --proxy=http://127.0.0.1:8080 sync

[jim4067]

Thanks for the suggestion. I think I'll go with it.

Unrelated, but I was also thinking of updating the config flag from continuous present tense to present tense.

From -c, --config <FILE> Sets a path to a configuration file (default: $HOME/.tool.toml)
to -c, --config <FILE> Set a path to a configuration file (default: $HOME/.tool.toml)