Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

uniform hyphen usage addresses #772 #779

Merged
merged 1 commit into from
Oct 30, 2016
Merged

uniform hyphen usage addresses #772 #779

merged 1 commit into from
Oct 30, 2016

Conversation

professorjamesmoriarty
Copy link

@professorjamesmoriarty professorjamesmoriarty commented Oct 28, 2016

I opt'd to use a single hyphen for options. And made a small note in regards to the ability to swap. I think a single hyphen fits because of the internal help examples use a single hyphen.

@professorjamesmoriarty professorjamesmoriarty changed the title uniform hyphen usage I opt'd to use a single hyphen for options. And made a small note in regards to the ability to swap. I think a single hyphen fits because of the internal help examples use a single hyphen. uniform hyphen usage Oct 28, 2016
@professorjamesmoriarty professorjamesmoriarty changed the title uniform hyphen usage uniform hyphen usage addresses #772 Oct 28, 2016
@odeke-em
Copy link
Owner

Thanks for working on this @shaggytwodope.

I have some comments on this:

  1. Please update the commit message to:
README: consistent hyphen usage for options in examples

Fixes #772
  1. I prefer using -- for long options because -- is customary for CLI's and the GNU long options style is very widespread for folks using the command line. In the future.
    I'll probably get rid of Go's flag in favour of something that accepts long and short options GNU style because Go's flag package also has some problems like the options have to precede any arguments so
$ drive list fewHere --long

would not catch --long, and would treat it as a path instead of an option. For it to work it would have to be:

$ drive list --long fewHere

yet in all other CLIs that I've encountered, the ordering won't matter.

@professorjamesmoriarty
Copy link
Author

@odeke-em Commit message changed. And yeah I think the "long" options make much more sense. For now tho I think this solves some confusion in the short term.

@odeke-em
Copy link
Owner

Fair enough, I see your concern with confusion results because firstly help gives - for help.

Thank you for fixing and advocating this.
LGTM!

@odeke-em odeke-em merged commit 19fcb58 into odeke-em:master Oct 30, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants