search

pystorm / streamparse

Run Python in Apache Storm topologies. Pythonic API, CLI tooling, and a topology DSL.
http://streamparse.readthedocs.io/
Apache License 2.0
1.5k stars 218 forks source link

feature request: cli commands options documentation #334

Closed mbande closed 7 years ago

mbande commented 7 years ago

e.g. sparse help stats to show stats options

Darkless012 commented 7 years ago

Do you mean: sparse stats -h ?

mbande commented 7 years ago

i don't know this command exists this is the one that should be documented!

dan-blanchard commented 7 years ago

I was initially about to comment that most commands traditionally take a -h or --help option and that this should be obvious, but I realized if you run sparse -h it is not obvious that --help works for all the sub-commands if you put it after the command. For example, sparse stats -h will show help for the stats sub-command, but sparse -h stats will show help for sparse itself. We should probably just make a help sub-command that is an alias to sparse SUBCOMMAND -h, and when we document it we can make it clear that since it's an alias, you can also do sparse SUBCOMMAND -h.