search

chshersh / tool-sync

🧰 Download pre-built binaries of all your favourite tools with a single command
https://crates.io/crates/tool-sync
Mozilla Public License 2.0
69 stars 16 forks source link

Missing docstring on proxy flag #141

Closed MitchellBerend closed 1 year ago

MitchellBerend commented 1 year ago

https://github.com/chshersh/tool-sync/blob/5d1a6b6010ca44ec81571c4d7b677c3cb01bb6cd/src/config/schema.rs#L13-L21 https://github.com/chshersh/tool-sync/blob/5d1a6b6010ca44ec81571c4d7b677c3cb01bb6cd/src/config/cli.rs#L5-L17

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 commented 1 year ago

let me look into this

MitchellBerend commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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)