Skip to content
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

Expand docstrings for annotated flag on control() and inverse() #11707

Closed
mtreinish opened this issue Feb 1, 2024 · 1 comment
Closed

Expand docstrings for annotated flag on control() and inverse() #11707

mtreinish opened this issue Feb 1, 2024 · 1 comment
Labels
documentation Something is not clear or an error documentation
Milestone

Comments

@mtreinish
Copy link
Member

What should we add?

In #11593 and #11433 we added a new argument annotated to the inverse() and control() methods respectively. The argument is used to control whether an AnnotatedOperation is returned instead of a concrete gate when the methods are called. However, in the cases of certain standard library gate classes, the argument was to the overloaded method definitions for interface consistency with their parent class, but the return is not effected by the value of the flag because the control or inverse have clear definitions in the standard library. However, not all the docstrings in these cases clearly document this, primarily because the overloaded methods have a single line docstring. Before we release 1.0.0 final we should ensure that we update the docstrings to make it clear when the annotated flag is ignored.

@mtreinish mtreinish added the type: feature request New feature or request label Feb 1, 2024
@mtreinish mtreinish added this to the 1.0.0 milestone Feb 1, 2024
@mtreinish mtreinish added documentation Something is not clear or an error documentation and removed type: feature request New feature or request labels Feb 1, 2024
@mtreinish
Copy link
Member Author

Fixed by: #11749

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or an error documentation
Projects
None yet
Development

No branches or pull requests

1 participant