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

Shorten command one line descriptions for main help #510

merged 2 commits into from Jul 5, 2016


None yet
2 participants
Copy link

peterjc commented Jul 4, 2016

This would close #183 by using pithy one-line help summaries for each command to avoid truncation in planemo --help, which now gives:

$ planemo --help
Usage: planemo [OPTIONS] COMMAND [ARGS]...

  A command-line toolkit for building tools and workflows for Galaxy.

  Check out the full documentation for Planemo online or open with ``planemo docs``.

  --version         Show the version and exit.
  -v, --verbose     Enables verbose mode.
  --config TEXT     Planemo configuration YAML file.
  --directory TEXT  Workspace for planemo.
  --help            Show this message and exit.

  brew                   Install tool requirements using brew.
  brew_env               List commands to inject brew dependencies.
  brew_init              Download linuxbrew install & run it in ruby.
  conda_env              How to activate conda environment for tool.
  conda_init             Download and install conda.
  conda_install          Install conda packages for tool requirements.
  config_init            Initialise global configuration for Planemo.
  create_gist            Upload file to GitHub as a sharable gist.
  cwl_script             Compile simple CWL workflows to shell script.
  database_create        Create a *development* database.
  database_delete        Delete a *development* database.
  database_list          List databases in configured database source.
  dependency_script      Compile tool_dependencies.xml to bash script.
  docker_build           Build (and optionally cache) Docker images.
  docker_shell           Launch shell in Docker container for a tool.
  docs                   Open Planemo documentation in web browser.
  lint                   Check for common errors and best practices.
  normalize              Generate normalized tool XML from input.
  profile_create         Create a profile.
  profile_delete         Delete a profile.
  profile_list           List configured profile names.
  project_init           (Experimental) Initialize a new tool project.
  run                    Planemo command for running tools and jobs.
  serve                  Launch Galaxy instance with specified tools.
  share_test             Publish JSON test results as sharable Gist.
  shed_build             Create a Galaxy tool tarball.
  shed_create            Create a repository in a Galaxy Tool Shed.
  shed_diff              diff between local repository and Tool Shed.
  shed_download          Download tool from Tool Shed into directory.
  shed_init              Bootstrap new Tool Shed .shed.yml file.
  shed_lint              Check Tool Shed repository for common issues.
  shed_serve             Launch Galaxy with Tool Shed dependencies.
  shed_test              Run tests of published shed artifacts.
  shed_update            Update Tool Shed repository.
  shed_upload            Low-level command to upload tarballs.
  syntax                 Open tool config syntax page in web browser.
  test                   Run specified tool's tests within Galaxy.
  test_reports           Generate human readable tool test reports.
  tool_factory           (Experimental) Launch Galaxy with Tool...
  tool_init              Generate tool outline from given arguments.
  travis_before_install  Internal command for GitHub/TravisCI testing.
  travis_init            Create files to use GitHub/TravisCI testing.
  virtualenv             Create a virtualenv.

Also corrected the create_gist help string which was copied from another command.

Shorten command one line descriptions for main help
See #183, want pithy summaries for: planemo --help

Also corrected the create_gist help string which was
copied from another command.

This comment has been minimized.

Copy link
Contributor Author

peterjc commented Jul 5, 2016

I'm pretty sure the TravisCI failures are pre-existing, i.e. separate issues.


This comment has been minimized.

Copy link

jmchilton commented Jul 5, 2016

Awesome - thanks a ton @peterjc - these look much better now.

@jmchilton jmchilton closed this Jul 5, 2016

@jmchilton jmchilton reopened this Jul 5, 2016

@jmchilton jmchilton merged commit cb89781 into galaxyproject:master Jul 5, 2016

1 check was pending

continuous-integration/travis-ci/pr The Travis CI build is in progress
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment