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

[release/5.0] Update SYSLIB0012 obsoletion messages to be clear and consistent #41483

Merged
merged 1 commit into from
Aug 28, 2020

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Aug 27, 2020

Backport of #41467 to release/5.0

/cc @jeffhandley

Customer Impact

The obsoletion message that was documented for SYSLIB0012 was unclear without surrounding context; it didn't state which APIs were obsolete nor did it state which Type the Location property was on.

Additionally, we found that the message used in src was different from what was on the ref assembly; the ref assembly had a clearer message. This makes the messages consistent across them while also adding the context for improved clarity.

Testing

Verified by introducing a violation (unsuppressing one of our internal suppressions) and reviewing the error message seen.

image

Risk

Very low. This is changing string literals used in Obsolete attributes.

@Dotnet-GitSync-Bot
Copy link
Collaborator

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

@jeffhandley
Copy link
Member

@ericstj Please consider this for release/5.0 port. Thank you.

@jkotas
Copy link
Member

jkotas commented Aug 27, 2020

It looks a bit odd to make this obsolete message talk about .NET Framework explicitly when the other obsolete messages do not. I have commented on it in #39261 (comment)

I do not care enough about this detail.

@jeffhandley
Copy link
Member

Thanks @jkotas. Sorry I missed that comment previously, but my care level for that detail is also low. @terrajobst agreed that the spec's message didn't provide enough context though.

Copy link
Member

@ericstj ericstj left a comment

Choose a reason for hiding this comment

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

Approved: fix to 5.0 feature work

@jeffhandley jeffhandley merged commit cb2023c into release/5.0 Aug 28, 2020
@jeffhandley jeffhandley deleted the backport/pr-41467-to-release/5.0 branch August 28, 2020 01:08
@ghost ghost locked as resolved and limited conversation to collaborators Dec 7, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants