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

Inital text omitted #7

Open
fsparv opened this issue Apr 21, 2015 · 2 comments
Open

Inital text omitted #7

fsparv opened this issue Apr 21, 2015 · 2 comments

Comments

@fsparv
Copy link

fsparv commented Apr 21, 2015

Initial text in usage file is not ouput as part of usage. Given a usage text of

Insert data into a solr cloud instance that is already up and running.
A prefix of 'java -jar ' is presumed for all usage below.

Usage:
  insert_test_data.jar <zkHost>

I only get the following output:

Usage:
  insert_test_data.jar <zkHost>

What's the point of supporting text above Usage: if it never gets printed...

(this is using the version that was helpfully published to central... 'com.offbytwo:docopt:0.6.0.20150202')

@damiengiese
Copy link
Contributor

The text above (an below, for that matter) "Usage:" will be printed if the --help option is specified.

Based on what you've described, I assume that you are running your JAR with no arguments. If so, what you are seeing is expected behavior.

Does that help?

@fsparv
Copy link
Author

fsparv commented May 9, 2015

Hmm, based on my memory, the clojure one did not require --help. To me that was preferable. Without the initial instructions regarding java -jar, one winds up having to repeat the java -jar on every line which is just a lot of clutter that makes the usage hard to read.

It seems like if there is no options section specifying --help as an option then there shouldn't be a hidden --help option, and everything should print every time.

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

2 participants