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

Intuitive help for procs #32

Open
olttwa opened this issue Oct 16, 2018 · 3 comments
Open

Intuitive help for procs #32

olttwa opened this issue Oct 16, 2018 · 3 comments

Comments

@olttwa
Copy link
Member

olttwa commented Oct 16, 2018

As a user,
I want procs help to be more intuitive.

Currently, If I fetch all procs using proctor list, and I need help for run-sample proc, I need to type command: proctor describe run-sample. That's unintuitive.

Instead, proctor help run-sample or proctor run-sample --help would be more intuitive for displaying help.

@olttwa
Copy link
Member Author

olttwa commented Oct 16, 2018

@raeoks @vjdhama thoughts? ^^

@detj
Copy link

detj commented Oct 16, 2018

@olttwa Yes, that'd better. Also support proctor --help. Right now, running proctor --help throws the error Error reading proctor config if I don't have a config setup yet. Help routine should not check for presence of config.

Do we have a proctor --version command ?

@vjdhama
Copy link

vjdhama commented Oct 16, 2018

@olttwa I prefer proctor run-sample --help over proctor help run-sample just because that's kind of unspoken standard for checking options of a subcommand and people expect it to be present by default.

olttwa pushed a commit that referenced this issue Nov 21, 2018
- Add intuitive help command for a proc
- Closes #38 #32
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

No branches or pull requests

3 participants