Rename applicability levels to Safe, Unsafe, and Display#7843
Merged
Conversation
Member
Author
|
Sorry for the churn I know this touches a lot of files. |
Contributor
PR Check ResultsEcosystem✅ ecosystem check detected no changes. |
charliermarsh
approved these changes
Oct 7, 2023
Member
charliermarsh
left a comment
There was a problem hiding this comment.
I like these names a lot.
konstin
pushed a commit
that referenced
this pull request
Oct 11, 2023
After working with the previous change in #7821 I found the names a bit unclear and their relationship with the user-facing API muddied. Since the applicability is exposed to the user directly in our JSON output, I think it's important that these names align with our configuration options. I've replaced `Manual` or `Never` with `Display` which captures our intent for these fixes (only for display). Here, we create room for future levels, such as `HasPlaceholders`, which wouldn't fit into the `Always`/`Sometimes`/`Never` levels. Unlike #7819, this retains the flat enum structure which is easier to work with.
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
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.
After working with the previous change in #7821 I found the names a bit unclear and their relationship with the user-facing API muddied. Since the applicability is exposed to the user directly in our JSON output, I think it's important that these names align with our configuration options. I've replaced
ManualorNeverwithDisplaywhich captures our intent for these fixes (only for display). Here, we create room for future levels, such asHasPlaceholders, which wouldn't fit into theAlways/Sometimes/Neverlevels.Unlike #7819, this retains the flat enum structure which is easier to work with.