Move preferred location of WrapAngles default registry
#15101
+74
−30
Conversation
This file contains hidden or 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
We forgot to do this in Qiskit 2.2.0, while including examples saying that it was something you were allowed to do. This meant that we were breaking our own public-API policy: suggesting that people use an object that was not correctly documented at any path. This corrects the documentation oversight in a stable manner, but unfortunately we cannot give it a more sensible import path within the 2.2 series, and we've inadvertently made this very wordy import path subject to the deprecation policy. Regardless, it would be better to follow up by giving it a better location.
jakelishman
added
on hold
|
One or more of the following people are relevant to this code:
|
In Qiskit 2.2 we inadvertently exposed the default registry only from the location `qiskit.transpiler.passes.utils.wrap_angles.WRAP_ANGLES_REGISTRY`, which traverses two private modules. We had to document that location in Qiskit 2.2 since it was already released when we spotted it, but had we caught it before, we'd have changed the import path to something easier and already public. This PR attaches the default registry to the class; the `WrapAngles` pass is called out as "special" from the `Target` as handling these angle wrappings, so it seems appropriate for its default registry to be attached there as well.
jakelishman
force-pushed
the
relocate-wrap-angles-registry
branch
from
3c4b429 to
cd58d67
Compare
kt474
previously approved these changes
Oct 1, 2025
Originally I thought I needed the extra `.. autoattribute` because I hadn't cleaned my docs build when I tried it.
Pull Request Test Coverage Report for Build 18168330353Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
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.
Summary
In Qiskit 2.2 we inadvertently exposed the default registry only from the location
qiskit.transpiler.passes.utils.wrap_angles.WRAP_ANGLES_REGISTRY, which traverses two private modules. We had to document that location in Qiskit 2.2 since it was already released when we spotted it, but had we caught it before, we'd have changed the import path to something easier and already public.This PR attaches the default registry to the class; the
WrapAnglespass is called out as "special" from theTargetas handling these angle wrappings, so it seems appropriate for its default registry to be attached there as well.Details and comments
Unstable follow-up to #15100.