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

Documentation around commands should be improved in particular related to: a. “default” options examples b. Actual examples when TAB #279

Open
andreivasiletruta opened this issue Mar 14, 2017 · 1 comment

Comments

@andreivasiletruta
Copy link
Contributor

From @meshipeer on April 6, 2015 7:43

Steps: Let’s consider the run command

  1. Issue the run command simply by run
    Actual result: One is prompted with “You should specify a default option (otherwise known as option 'f') for this command”.
    Expected result: One should know what to do after this message (run --f, run –f run f, what?!) through a short example maybe?
    Note: for instance if you trigger run –f you end up with the same message as above which is not ok.
  2. Now Issue the run command by run –f and press TAB
    Actual result: you are prompted with two options that do not state anything? What file I need to provide?
    Expected result: run command help (simple one and not the complex "help run") and example should be provided

Copied from original issue: CloudSlang/CloudSlang.github.io#74

@andreivasiletruta
Copy link
Contributor Author

From @SamMarkowitz on April 13, 2015 10:25

The explanation makes this look like an issue with the error messages, not the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant