add rule metadata to results set #940
Closed
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
|
drdavella
reviewed
Dec 4, 2024
|
|
||
| class ResultSet(dict[str, dict[Path, list[Result]]]): | ||
| results_for_rule: dict[str, list[Result]] | ||
| class Rule(CodetfRule): |
Member
There was a problem hiding this comment.
@clavedeluna what if instead of being prescriptive about the specific metadata fields here, we instead add a field with an abstract type that conforms to some API like get_metadata_summary() -> str and allow each tool to define the way they want to present it?
I also don't want to overengineer this without having a lot of examples to work with.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Overview
One sentence, high-level explanation of WHY changes are introduced and/or business need
Description
Additional Details