Skip to content

Commit 263784f

Browse files
authored
Mention ShowHelpException in README's help section
1 parent 5f5db43 commit 263784f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -455,8 +455,9 @@ In both cases exceptions will be thrown where parsing or validation errors are f
455455
## Help Formatting
456456

457457
By default, `ArgParser` will add a `--help` option (short name `-h`) for
458-
displaying usage information. If this option is present the program will halt
459-
and print a help message like the one below, based on the `ArgParser`
458+
displaying usage information. If this option is present a `ShowHelpException` will be thrown.
459+
If the default exception handling is being used (see [Error Handling](#error-handling)) the
460+
program will halt and print a help message like the one below, based on the `ArgParser`
460461
configuration:
461462

462463
usage: program_name [-h] [-n] [-I INCLUDE]... -o OUTPUT

0 commit comments

Comments
 (0)