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

Add documentation on 'noBacktrack' preference #300

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sseefried
Copy link

Subcommand parsers are often disjoint, meaning that if one fails
to parse after the command name then all others (having distinct
command names) will also fail to parse. When the 'noBacktrack'
preference is not set but 'showHelpOnError' is this leads to
the help for the top-level parser being shown instead of the
help for the failing subcommand.

A note has been added to the Haddock docs for the 'noBacktrack'
option to make this clear.

@sseefried
Copy link
Author

@HuwCampbell this should avoid a repeat of someone like me creating a (non-) issue like #298 in the future :-)

Subcommand parsers are often disjoint, meaning that if one fails
to parse after the command name then all others (having distinct
command names) will also fail to parse. When the 'noBacktrack'
preference is not set but 'showHelpOnError' is this leads to
the help for the top-level parser being shown instead of the
help for the failing subcommand.

A note has been added to the Haddock docs for the 'noBacktrack'
option to make this clear.
@sseefried sseefried force-pushed the PR-1-add-docs-on-noBacktrack-and-showHelp branch from e37c20a to 08edd73 Compare April 30, 2018 23:06
@sseefried sseefried changed the title Add documentation on 'noBacktrack' option Add documentation on 'noBacktrack' preference Apr 30, 2018
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

Successfully merging this pull request may close these issues.

1 participant