Improve docstring for Statevector.evolve
#9666
Merged
Conversation
This file contains 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
I didn't realize from the generated documentation that `Statevector.evolve` can accept an `Instruction` or `QuantumCircuit`, not just an `Operator`. I only learned it once I found myself reading the source. This modifies the docstring to make it explicit.
|
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 4307079157
💛 - Coveralls |
jakelishman
added
documentation
jakelishman
reviewed
Feb 27, 2023
| @@ -360,7 +360,7 @@ def evolve(self, other, qargs=None): | |||
| """Evolve a quantum state by the operator. | |||
|
|
|||
| Args: | |||
| other (Operator): The operator to evolve by. | |||
| other (Operator | QuantumCircuit | Instruction): The operator to evolve by. | |||
There was a problem hiding this comment.
Oh, Sphinx is actually complaining about the lookup of Instruction is ambiguous. I think if you make it circuit.Instruction it should be happy again.
jakelishman
approved these changes
Mar 1, 2023
mergify bot
pushed a commit
that referenced
this pull request
Mar 1, 2023
* Improve docstring for `Statevector.evolve` I didn't realize from the generated documentation that `Statevector.evolve` can accept an `Instruction` or `QuantumCircuit`, not just an `Operator`. I only learned it once I found myself reading the source. This modifies the docstring to make it explicit. * Disambiguate `Instruction` #9666 (comment) --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit d6a8816)
mergify bot
added a commit
that referenced
this pull request
Mar 1, 2023
* Improve docstring for `Statevector.evolve` I didn't realize from the generated documentation that `Statevector.evolve` can accept an `Instruction` or `QuantumCircuit`, not just an `Operator`. I only learned it once I found myself reading the source. This modifies the docstring to make it explicit. * Disambiguate `Instruction` #9666 (comment) --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit d6a8816) Co-authored-by: Jim Garrison <garrison@ibm.com>
king-p3nguin
pushed a commit
to king-p3nguin/qiskit-terra
that referenced
this pull request
May 22, 2023
* Improve docstring for `Statevector.evolve` I didn't realize from the generated documentation that `Statevector.evolve` can accept an `Instruction` or `QuantumCircuit`, not just an `Operator`. I only learned it once I found myself reading the source. This modifies the docstring to make it explicit. * Disambiguate `Instruction` Qiskit#9666 (comment) --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
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
I didn't realize from the generated documentation that
Statevector.evolvecan accept anInstructionorQuantumCircuit, not just anOperator. I only learned it once I read the source. This modifies the docstring to make it explicit.Details and comments