Skip to content
This repository has been archived by the owner on Oct 7, 2020. It is now read-only.

Odd usage alignment #13

Open
denis-yuen opened this issue May 2, 2017 · 2 comments
Open

Odd usage alignment #13

denis-yuen opened this issue May 2, 2017 · 2 comments
Assignees

Comments

@denis-yuen
Copy link
Member

Usage: client [options] [command] [command options]
  Options:
    --config
      Config file location.
      Default: /home/dyuen/.dockstore/write.api.config.properties
    --help
      Prints help for the client.
      Default: false
  Commands:
    add      Add the Dockerfile and CWL file(s) using the write API.
      Usage: add [options]
        Options:
        * --Dockerfile
            The Dockerfile to upload
        * --cwl-file
            The cwl descriptor to upload
          --cwl-secondary-file
            The optional secondary cwl descriptor to upload
          --help
            Prints help for the add command
            Default: false
          --version
            The version of the tool to upload to

    publish      Publish tool to dockstore using the output of the 'add' 
            command. 
      Usage: publish [options]
        Options:
          --help
            Prints help for the publish command.
            Default: false
        * --tool
            The json output from the 'add' command.

Note that "Add the Dockerfile" and "Publish tool to dockstore" seem misaligned

@garyluu
Copy link
Contributor

garyluu commented May 4, 2017

If "Publish" was unindented 1 level, it would get too close to "publish". There would only be one space between then. If "Add" was indented 1 level to match "Publish", it would waste space. If "command." was indented 1 level, it would also waste space.

JCommander generates the usage. If command description was multiple lines, this current way of displaying usage makes more sense. It tries to minimize the amount of wasted space by not line-breaking after the command, it also leaves at least 2 after the command (however long it is).

@garyluu
Copy link
Contributor

garyluu commented May 25, 2017

Apparently, it's not indented. JCommander puts the command name then followed by 6 spaces and then the description pretty much no matter what.

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

No branches or pull requests

2 participants