Expand docstrings for annotated flag on control() and inverse()
#11749
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
ElePT
added
documentation
|
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 7869598198Details
💛 - Coveralls |
mtreinish
reviewed
Feb 8, 2024
mtreinish
added
the
stable backport potential
Apply suggestions from Matt's code review Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
|
Thanks for taking the time to write all the suggestions, I had to format them a bit to make lint happy, but I took it as a chance to double-check that the messages make sense for the corresponding gates. |
mtreinish
reviewed
Feb 10, 2024
mtreinish
reviewed
Feb 10, 2024
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
mtreinish
approved these changes
Feb 12, 2024
mergify bot
pushed a commit
that referenced
this pull request
Feb 12, 2024
…11749) * Add annotated * Add returns * Co-authored-by: Matthew Treinish <mtreinish@kortar.org> Apply suggestions from Matt's code review Co-authored-by: Matthew Treinish <mtreinish@kortar.org> * Format suggestions * Fix lint * Apply last round of suggestions Co-authored-by: Matthew Treinish <mtreinish@kortar.org> --------- Co-authored-by: Matthew Treinish <mtreinish@kortar.org> (cherry picked from commit 381a8d9)
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 12, 2024
…11749) (#11774) * Add annotated * Add returns * Co-authored-by: Matthew Treinish <mtreinish@kortar.org> Apply suggestions from Matt's code review Co-authored-by: Matthew Treinish <mtreinish@kortar.org> * Format suggestions * Fix lint * Apply last round of suggestions Co-authored-by: Matthew Treinish <mtreinish@kortar.org> --------- Co-authored-by: Matthew Treinish <mtreinish@kortar.org> (cherry picked from commit 381a8d9) Co-authored-by: Elena Peña Tapia <57907331+ElePT@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
Documents
annotatedargument forinverse()in all gates in the standard library that provider their own implementation. I found thatcontrol()was already documented, but I made sure the types were indicated in the signature instead of the args. definition to make @Cryoris happy (unfortunately there is still quite a lot of inconsistency documenting the types).Details and comments
Addresses #11707.
I only looked for gates in the standard library, if you know of any other affected gates, let me know and I can add them to the PR.