`--config STRING` option description is confusing #810

Closed
p opened this Issue Jan 8, 2013 · 2 comments

Projects

None yet

2 participants

@p
p commented Jan 8, 2013

Maybe it's just me but STRING suggests a string of options, i.e. #807. I would expect something like --config PATH to refer to a path.

The other options taking arguments are similarly confusing:

-v, --version BOOLEAN display package version

This is the first time I see a version option taking an argument. What the argument means is not documented.

  --reporter STRING  custom reporter

I have not read enough of documentation to know what this option does but similarly to --config PATH you could maybe rename the parameter to something that would indicate what values it could take? Is it a class name/path to a file/something else? (I am unable to find anything useful searching google for "jshint reporter".)

@p
p commented Jan 8, 2013

It appears that master does not have boolean argument for version.

@valueof
Member
valueof commented Jul 1, 2013

This is how the cli module we use works. I will update the description to make it more clear.

@valueof valueof closed this in b937895 Jul 1, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment