Improve documentation for obsoletion/analyzer diagnostics #51595
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
jeffhandley
added
documentation
|
@JeremyKuhne I tagged you for review on this since I'd like to make sure you think this documentation would have sufficiently helped you with your recent obsoletion. Please let me know if you have any suggestions to make it even better. |
danmoseley
reviewed
Apr 20, 2021
stephentoub
reviewed
Apr 21, 2021
stephentoub
approved these changes
Apr 21, 2021
|
@JeremyKuhne I went ahead and merged but please let me know if you have any feedback/suggestions and I can augment if needed. |
|
It looks much better @jeffhandley, thanks! |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
We've had some obsoletions go into effect recently where it became clear our documentation around handling this was insufficient. This PR augments the obsoletion doc so that we have better guidance available.
Note that this PR still leaves
SYSLIB0014as absent from the list of obsoletions; PR #51550 adds that row to the table.