Skip to content

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

Description

@andreivasiletruta

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

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions