Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upUpdate README.md #52
Update README.md #52
Conversation
Add helpfull description for help message showing
codecov-io
commented
Mar 23, 2018
Codecov Report
@@ Coverage Diff @@
## master #52 +/- ##
=========================================
Coverage 82.97% 82.97%
Complexity 138 138
=========================================
Files 11 11
Lines 417 417
Branches 82 82
=========================================
Hits 346 346
Misses 36 36
Partials 35 35 Continue to review full report at Codecov.
|
e.printAndExit() | ||
} | ||
``` | ||
|
This comment has been minimized.
This comment has been minimized.
xenomachina
Mar 23, 2018
Owner
Thanks for pointing that this was not clear enough!
The supported way to do this is actually to use mainBody
, or at least to catch all SystemExitException
s, as mentioned in the Error Handling section.
Perhaps just change this to say something like:
For help messages to correctly display you must properly handle any
SystemExitException
that is thrown as described in Error Handling.
You could even link to that section.
This comment has been minimized.
This comment has been minimized.
InsanusMokrassar
Apr 28, 2018
Author
Thank you for your response.
I think, that catch only awaited exception (such as ShowHelpException
) is best way. In this case we need to catch only exception which will say to show help and catching ShowHelpException
will give us all what we need.
This comment has been minimized.
This comment has been minimized.
xenomachina
Apr 28, 2018
Owner
I don't think I understand your point.
ShowHelpException
is a subclass of SystemExitException
. In most cases you probably want to handle all SystemExitException
s, not just ShowHelpException
. They all contain a message for the user, as well as an exit code. The exit code for ShowHelpException
just happens to be 0.
This comment has been minimized.
This comment has been minimized.
InsanusMokrassar
May 3, 2018
Author
I mean that any other exception must be handled by other way. In this case we need to catch just ShowHelpException
and it is will be ok for show help message
This comment has been minimized.
This comment has been minimized.
xenomachina
May 3, 2018
Owner
But you don't need to handle other SystemExitExceptions in a different way. All SystemExitExceptions can be handled by calling their printAndExit()
method or by using mainBody
(which will call printAndExit
for you). It would be pretty unusual to need to catch only ShowHelpException
.
InsanusMokrassar commentedMar 23, 2018
Add helpfull description for help message showing