search

teamhephy / workflow-cli

MIT License
2 stars 13 forks source link

apps:destroy should have a more explicit help message #4

Open Cryptophobia opened 6 years ago

Cryptophobia commented 6 years ago

From @Overdrivr on June 14, 2017 5:1

Running 

deis apps:destroy <app-name>

yields the help message because syntax is not correct. The -a flag is missing. However, the help message is not very helpful, it should at least mention this flag.

$ deis apps:destroy italic-nuthatch
Usage: deis apps:destroy [options]

It's not a big deal, but IMO it would improve ergonomy a little bit

Copied from original issue: deis/workflow-cli#310

Cryptophobia commented 6 years ago

From @Joshua-Anderson on June 14, 2017 16:21

Is deis apps:destroy --help helpful for you? As a general rule we didn't list options because they're fairly standardized and not necessary. For example, running deis apps:destroy in the app's directory would destroy it.

Cryptophobia commented 6 years ago

From @bacongobbler on June 14, 2017 16:24

Perhaps a follow-up would be to display the help text instead of a generic usage message. That way it's the best of both worlds: the user gets more helpful usage instructions, and we don't have to individually list each option flag available to each command.

Cryptophobia commented 6 years ago

From @bacongobbler on June 14, 2017 16:26

I know cobra has a way to change the usage message... Not sure about docopt-go (what workflow-cli uses).

Cryptophobia commented 6 years ago

From @Overdrivr on June 15, 2017 5:44

@Joshua-Anderson My bad, I thought I was already getting the full help message while in fact it was a stripped down version. I do agree with you @bacongobbler