[DOC] improved deprecation recipes #5890
Merged
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
fkiraly
requested review from
achieveordie,
benHeid and
yarnabrina
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR splits the current deprecation recipe example into two, and adds more details.
FYI @yarnabrina, I think your example was quite nice, but it combined two of the "base recipes" (changing default value, changing name), so is probably going to be confusing to a new developer. It is better if any examples match one of the recipes 1:1. I think it also was not entirely in line with the recipe (e.g., use of
Nonevs string"deprecated").Ultimately, I split it into two 1:1 examples for the two base recipes that the current example was composed of.
Also fixes some indentation issues which made the recipes format strangely.