Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename applicability levels to Safe, Unsafe, and Display #7843

Merged
merged 1 commit into from
Oct 7, 2023

Conversation

zanieb
Copy link
Member

@zanieb zanieb commented Oct 6, 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.

@zanieb
Copy link
Member Author

zanieb commented Oct 6, 2023

Sorry for the churn I know this touches a lot of files.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 6, 2023

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Copy link
Member

@charliermarsh charliermarsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like these names a lot.

@zanieb zanieb marked this pull request as ready for review October 7, 2023 00:41
@zanieb zanieb merged commit 0fc76ba into main Oct 7, 2023
16 checks passed
@zanieb zanieb deleted the zanie/applicability-levels branch October 7, 2023 01:50
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants