Add a decompose() call to circuit library table in docs #7819
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
For the purpose of documentation many of the circuit library classes were using the circuit_library_widget to provide a visualization of the circuit, a QASM definition, and some basic high level statistics about the circuit. However, since Qiskit#6634 and Qiskit#6659 all the circuit library elements are wrapped in an outer Instruction object. This makes the top level object appear as a logical block in the circuit. This has the unindended side effect of causing the widget output to not be super useful, primarily it would should a single logical block for each element and the circuit statistics would be for the single element as opposed to its implementation. This commit address this by adding a single decompose() call around all the statistics and drawing calls inside the widget code. Since we're consistently wrapping every circuit library element the widget will always need to do this now, so instead of calling it directly in the library docstring it's better to just do this in the widget itself.
Pull Request Test Coverage Report for Build 2041842862
💛 - 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
For the purpose of documentation many of the circuit library classes
were using the circuit_library_widget to provide a visualization of
the circuit, a QASM definition, and some basic high level statistics
about the circuit. However, since #6634 and #6659 all the circuit
library elements are wrapped in an outer Instruction object. This
makes the top level object appear as a logical block in the circuit.
This has the unintended side effect of causing the widget output to not
be super useful, primarily it would should a single logical block for
each element and the circuit statistics would be for the single element
as opposed to its implementation. This commit address this by adding a
single decompose() call around all the statistics and drawing calls
inside the widget code. Since we're consistently wrapping every circuit
library element the widget will always need to do this now, so instead
of calling it directly in the library docstring it's better to just do
this in the widget itself.
Details and comments