Add type-set default value to help text #83
Merged
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.
As mentioned in #61, it would be nice if default values showed up in help messages. This PR implements such a change that I'm using personally and thought might be desired upstream.
This is a small change so that a field with
<!> "defaultValue"
will show(Default: defaultValue)
in the help string. I opted to put this in theparseFields
definition, which means that the order of field decorators now matters: that is, if one writes... <!> "1" <?> "Field help"
, then the help text will readField help (Default: 1)
, but if the order is... <?> "Field help" <!> "1"
, then the help text will readField help
. This is by design so that the behavior could be overridden if desired.