docs: Unify style of CLI arguments

tus / tusd

Reference server implementation in Go of tus: the open protocol for resumable file uploads

https://tus.github.io/tusd

MIT License

3.05k stars 475 forks source link

docs: Unify style of CLI arguments #1050

Closed martnst closed 9 months ago

martnst commented 9 months ago

Update CLI option examples from 2 leading dashes to just 1.

Acconut commented 9 months ago

Thank you for the PR, but what is your motivation behind this? Go's flag parser supports options being supplied with two and just one dash. So the examples are correct AFAIK.

martnst commented 9 months ago

Ah okay. I don't know much about go yet. I had noticed that tusd -h lists everything with a single dash. Thus, I thought the docs might be outdated.

So with that, now I think for sake of consistency it would be nice to align it.

Acconut commented 9 months ago

Thanks for this! I just saw that we also use single dashes in the majority of our documentation, so I agree that we should keep it consistent :)