Fix default display in help for EnumerableFlag and other types#486
Merged
Conversation
In the help for flags like --prefix/--no-prefix, use the name of the default flag instead of true/false.
When EnumerableFlag types have separate help strings, show the correct default flag name on the default flag in the help.
Collaborator
|
Ooh this is a nice fix! |
Member
Author
|
Will almost certainly conflict with #477, let's land that first! |
# Conflicts: # Sources/ArgumentParser/Parsable Properties/Flag.swift # Sources/ArgumentParser/Parsing/ArgumentSet.swift # Tests/ArgumentParserUnitTests/HelpGenerationTests.swift
Member
Author
|
@swift-ci Please test |
This file contains hidden or 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
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.
When an
EnumerableFlagflag has a default value, the default is printed incorrectly as the instance value in the help, instead of as the flag that a user would need to type. The same issue is present for Boolean flags with both an inversion and a default.Old help output:
Corrected help output:
Checklist