[wip] Better handle pending deprecations #9601
Closed
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.
Summary
Our deprecation policy distinguishes between
DeprecationWarning
vsPendingDeprecationWarning
: https://github.com/Qiskit/qiskit/blob/82810146c5061fad17c041e7e66196f92466ec1a/docs/deprecation_policy.rst#removing-a-featureThis PR improves support for
PendingDeprecationWarning
:deprecate_arguments
to clarify when something is pending.category: type
, which was unbounded to be the whole universe of Python types. When in reality, we only expected it to be eitherDeprecationWarning
orPendingDeprecationWarning
.pending={False,True}
makes clear this reality. It will help in future changes (like Deprecate warning box in docs #8600) to conditionally handle pending vs deprecated.Details and comments
This is prework for the rework ofchttps://github.com//pull/8600. I want to make sure our docs properly support
PendingDeprecationWarning
.