Display possible option values in help #594
Merged
Conversation
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
rauhul
force-pushed
the
all-values-in-help
branch
3 times, most recently
from
c8ec27d to
e699a93
Compare
|
@swift-ci please test |
natecook1000
reviewed
Nov 8, 2023
There was a problem hiding this comment.
This looks great! I'm a little concerned about how this will affect the help when a CaseIterable type has a large number of values. Can we update the allValueStrings documentation to show how to suppress/limit that number, or would it make sense to provide a configuration property to ArgumentHelp? (e.g. maxCaseDisplay)
Sources/ArgumentParser/Documentation.docc/Articles/CustomizingHelp.md
Outdated
Show resolved
Hide resolved
Sources/ArgumentParser/Documentation.docc/Articles/CustomizingHelp.md
Outdated
Show resolved
Hide resolved
Sources/ArgumentParser/Documentation.docc/Articles/CustomizingHelp.md
Outdated
Show resolved
Hide resolved
Sources/ArgumentParser/Documentation.docc/Articles/CustomizingHelp.md
Outdated
Show resolved
Hide resolved
Sources/ArgumentParser/Documentation.docc/Articles/CustomizingHelp.md
Outdated
Show resolved
Hide resolved
Sources/ArgumentParser/Parsable Types/ExpressibleByArgument.swift
Outdated
Show resolved
Hide resolved
Sources/ArgumentParser/Documentation.docc/Articles/CustomizingHelp.md
Outdated
Show resolved
Hide resolved
|
@swift-ci please test |
Updates HelpGenerator to print possible value options as a suffix to the user defined help string. In practice this looks like: > Set diagnostic level to report public declarations without an > availability attribute. (values: error, warn, ignore; default: warn)
rauhul
force-pushed
the
all-values-in-help
branch
from
eb4bff4 to
cffff99
Compare
|
@swift-ci please test |
natecook1000
approved these changes
Nov 14, 2023
4 tasks
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.
Updates HelpGenerator to print possible value options as a suffix to the
user defined help string. In practice this looks like: