Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork33.7k
Open
Description
In the docs we have two directives that can be used todocument deprecations:deprecated anddeprecated-removed.
I think we should always prefer the latter:
- it will make it easier to track and document removals
- it will give people a target, so they can plan around it
Even if the removal version gets postponed, it's better to postpone than to say that something is deprecated and then just remove it at an unspecified time in the future.
Currentlydeprecated is more commonly used:
$ grep -r 'deprecated::' --include=*.rst | wc -l226$ grep -r 'deprecated-removed::' --include=*.rst | wc -l30- set removal version for deprecated features using
deprecated-removed - automate the documentation of deprecations (see alsoBetter emphasise pending removals in What's New #92308)
- possibly deprecate the
deprecateddirective and replace it withdeprecated-removed