-
Notifications
You must be signed in to change notification settings - Fork 127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update old links in documentation #1374
Update old links in documentation #1374
Conversation
:attr:`qiskit.providers.BackendV2.max_circuits` wasn't linking to the correct anchor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good but we might want to stop referencing the Qiskit deprecation policy now that Qiskit is aiming for a bigger stability guarantee with 1.0.
@@ -361,15 +362,15 @@ There are a few other build options available: | |||
### Deprecation policy | |||
|
|||
Qiskit Experiments is part of Qiskit and, therefore, the [Qiskit Deprecation | |||
Policy](https://qiskit.org/documentation/deprecation_policy.html) fully applies here. | |||
Policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md) fully applies here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was concerned that this policy might not apply to experiments now with 1.0 but DEPRECATION.md
just contains the same content that we were linking to (which is hard to find now that the old link redirects to DEPRECATION.md
but you can see it here). I think DEPRECATION.md
might still get an update for 1.0.
Should we decouple from the Qiskit repo by copying more of the old policy over here? We don't need to do it in this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I'll open a new PR for adding our own DEPRECATION.md
based on the current Qiskit one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps we could still link to the Qiskit one rather than copying all of it and say something like "Changes and removals of public facing interfaces must be preceded by a deprecation warning in at least one previous minor release published at least three months before the change. The Qiskit deprecation guide has good advice on how to deprecate a feature. Follow it when possible, but note that Qiskit Experiments has a different release model than Qiskit." I think we want to take out the "part of Qiskit and the Qiskit policy fully applies here" part.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in #1385.
Now that the docs have moved to https://qiskit-extensions.github.io/qiskit-experiments/, this PR updates links that were changed in the 1XP move.