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

Unclear from usage output what [ExportArgs...] are #13

Closed
n9yty opened this issue Oct 6, 2017 · 6 comments
Closed

Unclear from usage output what [ExportArgs...] are #13

n9yty opened this issue Oct 6, 2017 · 6 comments
Milestone

Comments

@n9yty
Copy link

n9yty commented Oct 6, 2017

Sorry, failure on my part. :(

@n9yty n9yty closed this as completed Oct 6, 2017
@schierlm
Copy link
Owner

schierlm commented Oct 6, 2017

No problem. Add an output file name and it should work :)

@renehamburger
Copy link

I made the same mistake. It would be good to add this to the command line help: java -jar BibleMultiConverter.jar <ImportFormat> <ImportFile> <ExportFormat> [<ExportArgs>...].

@schierlm
Copy link
Owner

schierlm commented Jun 4, 2018

What exactly to add here? That exact line is part of the output of java -jar BibleMultiConverter.jar.

Also feel free to open a pull request :)

@schierlm schierlm reopened this Jun 4, 2018
@renehamburger
Copy link

Yes, sorry, that wasn't very clear what I wrote there. That's the exact line from your command line help, but it does not mention <ExportFile>. It seems that a more complete command description would be java -jar BibleMultiConverter.jar <ImportFormat> <ImportFile> <ExportFormat> <ExportFile> [<ExportArgs>...]
It's also not clear what the optional <ExportArgs> are. Are they documented anywhere outside the sources?

@schierlm schierlm changed the title Exception in thread "main" java.lang.ArrayIndexOutOfBoundsException: 1 Unclear from usage output what [ExportArgs...] are Jun 5, 2018
@schierlm
Copy link
Owner

schierlm commented Jun 5, 2018

Export args are shown when you call

java -jar BibleMultiConverter.jar help <ExportFormat>

Some formats don't have an export file, but an export directory, or two export files, or some extra mandatory parameters (to choose how to export it) - see for example #15

Will try to put this information at the top of the output (so that it is not that far away from the Usage line).

@schierlm schierlm added this to the v0.0.7 milestone Jun 9, 2018
@renehamburger
Copy link

Thanks for the clarification, @schierlm! I can imagine a lot of people will stumble over this. Especially as [<ExportArgs>...] are presented as optional arguments.

When you touch that part of the code the next time, maybe add an error message for missing output file (or any required ExportArgs). The uncaught Exception in thread "main" java.lang.ArrayIndexOutOfBoundsException doesn't point the user into the right direction.

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

3 participants