docs: strikethrough deprecated methods on api index #2067
Merged
Conversation
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
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #2067 +/- ##
=======================================
Coverage 99.61% 99.61%
=======================================
Files 2535 2535
Lines 242202 242202
Branches 1292 1295 +3
=======================================
+ Hits 241258 241268 +10
+ Misses 917 907 -10
Partials 27 27 |
ST-DDT
reviewed
Apr 17, 2023
There was a problem hiding this comment.
I somewhat like it, but I'm not sure whether the user easily understands that the methods there are deprecated/what the strike-through should mean.
Also I'm not sure whether this adds any kind of benefit. If you notice a method doing what you search for then you click on it. If it happens to be deprecated, you will read the deprecation hint pointing to the right method.
ST-DDT
added
c: docs
|
The idea is if you are skimming looking for the right method you can focus on the ones that are non-deprecated. |
|
Team Decision
|
ST-DDT
added
s: accepted
xDivisionByZerox
previously approved these changes
Apr 20, 2023
Co-authored-by: ST-DDT <[email protected]>
Shinigami92
dismissed stale reviews from ST-DDT and xDivisionByZerox
via
4907c71
Shinigami92
approved these changes
Apr 20, 2023
ST-DDT
approved these changes
Apr 20, 2023
xDivisionByZerox
approved these changes
Apr 20, 2023
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.
Strikes through deprecated methods on API index page so its easier to see the non-deprecated methods
Example:
