Simplify the --report option #95
Merged
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
This commit brings --report in line with --platform, such that: - Each instance of --report accepts only a single argument. - --report can be specified multiple times. This is a breaking change, but --report accepting multiple values was deprecated in 1.2.0. Signed-off-by: John Pennycook <john.pennycook@intel.com>
laserkelvin
approved these changes
Apr 3, 2024
Signed-off-by: John Pennycook <john.pennycook@intel.com>
laserkelvin
approved these changes
Apr 4, 2024
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.
This commit brings
--reportin line with--platform, such that:--reportaccepts only a single argument.--reportcan be specified multiple times.This is a breaking change, but
--reportaccepting multiple values was deprecated in 1.2.0.Related issues
Part of the fix for #87.
Proposed changes
--reportfrom expecting a list of args (nargs="+") to a single argument.--reportarguments to a list of report options.--report allfor backwards compatibility.Note that setting a default of
["all"]forargparsewould then cause the list to always contain"all". Rather than writing a custom action for this, it seemed simpler to handle the default elsewhere and add a comment explaining the reasoning.