Skip to content

[0.46] Update the deprecation decorator towards SemVer#11564

Closed
1ucian0 wants to merge 3 commits into
Qiskit:stable/0.46from
1ucian0:0/docs/deprecation/1
Closed

[0.46] Update the deprecation decorator towards SemVer#11564
1ucian0 wants to merge 3 commits into
Qiskit:stable/0.46from
1ucian0:0/docs/deprecation/1

Conversation

@1ucian0
Copy link
Copy Markdown
Member

@1ucian0 1ucian0 commented Jan 15, 2024

This is the stable/0.46 version of #11296 (as merigify didnt do what I was expecting).


The current deprecate decorators extend the docstring with the following:

current

I suggest the following to be aligned with Qiskit/documentation#366

suggestion

@1ucian0 1ucian0 requested review from a team and woodsp-ibm as code owners January 15, 2024 12:34
@qiskit-bot
Copy link
Copy Markdown
Collaborator

One or more of the the following people are requested to review this:

  • @Qiskit/terra-core

@1ucian0 1ucian0 added this to the 0.46.0 milestone Jan 15, 2024
@jakelishman
Copy link
Copy Markdown
Member

Mergify's just waiting for the base PR to merge before it opened a backport. It might be best to wait for it to do that, just so we can be sure we get all the changes synced between the branches.

@mtreinish
Copy link
Copy Markdown
Member

Based on my review comments on #11296 I don't think this PR is eligible for 0.46.0. It introduces an API change to the behavior of the decorator (as the default behavior changes) as this is a public interface and downstream libraries are actively using it. 0.46.0 is supposed to be fully compatible with 0.45.x and this would break that messaging. We could do it as a new feature add, where None is an explicitly new type allowed for the decorator but the default message still shows the previous default message. But then that would require updating all the decorator usage in the repo. Given that 0.46.0 is supposed to be released today I've just untagged this from the 0.46.0 milestone

@mtreinish mtreinish removed this from the 0.46.0 milestone Feb 1, 2024
@1ucian0
Copy link
Copy Markdown
Member Author

1ucian0 commented Sep 20, 2024

0.46 is close to end-of-life. Closing this one.

@1ucian0 1ucian0 closed this Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants