Make usage-/help-string behavior consistent with original docopt
#59
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes docopt#32. This makes 3 main changes to this library's behavior: 1) `pUsagePatterns` (and thus `pDocopt`) parses out the "Usage:" section of the helpstring as a string and returns that. The way I'm parsing it feels really hacky but I wasn't sure a better way to achieve it. 2) `exitWithUsage` and `exitWithUsaegMessage` now print that "short usage string" rather than the whole helpstring. `exitWithHelpstring` has been added, which prints the whole helpstring. 3) `parseArgsOrExit` automatically exits printing the helpstring if `longOption "help"` is present, to be more consistent with the original `docopt` behavior. I'm not sure this is the correct place in the library to put it, but it creates the intended behavior.
|
Ah, thank you for opening a new PR! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #32.
(moved from #50 -- it looks like it'll need a few more edits now since 2.5 years ago :) )
This makes 3 main changes to this library's behavior:
pUsagePatterns(and thuspDocopt) parses out the "Usage:" sectionof the helpstring as a string and returns that. The way I'm parsing
it feels really hacky but I wasn't sure a better way to achieve it.
exitWithUsageandexitWithUsaegMessagenow print that "shortusage string" rather than the whole helpstring.
exitWithHelpstringhas been added, which prints the whole helpstring.
parseArgsOrExitautomatically exits printing the helpstring iflongOption "help"is present, to be more consistent with theoriginal
docoptbehavior. I'm not sure this is the correct place inthe library to put it, but it creates the intended behavior.