Expand docstrings for annotated
flag on control()
and inverse()
#11707
Labels
documentation
Something is not clear or an error documentation
Milestone
What should we add?
In #11593 and #11433 we added a new argument
annotated
to theinverse()
andcontrol()
methods respectively. The argument is used to control whether anAnnotatedOperation
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 theannotated
flag is ignored.The text was updated successfully, but these errors were encountered: