docs: mark deprecated parameter options #1962
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
ST-DDT
added
c: docs
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #1962 +/- ##
=======================================
Coverage 99.63% 99.64%
=======================================
Files 2384 2384
Lines 238992 238992
Branches 1230 1235 +5
=======================================
+ Hits 238123 238140 +17
+ Misses 847 830 -17
Partials 22 22 |
|
Here a (faked) visual example:
|
xDivisionByZerox
previously approved these changes
Mar 22, 2023
|
How about also adding some strikethrough on the parameter name? |
Done |
xDivisionByZerox
approved these changes
Mar 23, 2023
matthewmayer
approved these changes
Mar 23, 2023
Shinigami92
approved these changes
Mar 24, 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.
Created based on: #1960 (comment) and might be useful for #1919 as well.
Since we have switched from multiple parameters to a single options params, it is likely that we get deprecated options in the future.
This PR adds a
DEPRECATED:prefix to deprecated parameter options to increase visibility of these parameters in the docs..