Improve docstrings for controlled common gate overrides #3117

dabacon · 2020-07-01T23:15:12Z

Follow up to #3113 to improve the docstrings.

cirq/ops/common_gates.py

-        the ZPowGate is 0, otherwise it produces a normal ControlledGate.
-
-        (Note that a CZPowGate is, by definition, a controlled-ZPowGate.)
+        Returns a `CZPowGate` or a controlled `CZPowGate` when possible.


cirq/ops/common_gates.py

-        the CXPowGate is 0, otherwise it produces a normal ControlledGate.
-
-        (Note that a CCXPowGate is, by definition, a controlled-CXPowGate.)
+        Returns a `CCXPowGate` or a controlled `CCXPowGate` when possible.


cirq/ops/common_gates.py

balopat · 2020-07-01T23:25:37Z

cirq/ops/common_gates.py

+
+        The `controlled` method of the `Gate` class, of which this class is a
+        child, returns a `ControlledGate`. This method overrides this behavior
+        to return a `CXPowGate` or a `ControlledGate` of a `CXPowGate, when


Suggested change

to return a `CXPowGate` or a `ControlledGate` of a `CXPowGate, when

to return a `CXPowGate` or a `ControlledGate` of a `CXPowGate`, when

Same as above. Also need to add ` before "," here and below.

cirq/ops/common_gates.py

+
+        If these conditions are met, then the returned object is a `CXPowGate`
+        or, in the case that there is more than one controlled qudit, a
+        `ControlledGate` with the `Gate` being a `CXPowGate`. In the


cirq/ops/common_gates.py

+
+        The `controlled` method of the `Gate` class, of which this class is a
+        child, returns a `ControlledGate`. This method overrides this behavior
+        to return a `CZPowGate` or a `ControlledGate` of a `CZPowGate`, when


cirq/ops/common_gates.py

+
+        If these conditions are met, then the returned object is a `CCXPowGate`
+        or, in the case that there is more than one controlled qudit, a
+        `ControlledGate` with the `Gate` being a `CCXPowGate`. In the


cirq/ops/common_gates.py

-        the CZPowGate is 0, otherwise it produces a normal ControlledGate.
-
-        (Note that a CCZPowGate is, by definition, a controlled-CZPowGate.)
+        Returns a `CCZPowGate` or a controlled `CCZPowGate` when possible.


cirq/ops/common_gates.py

smitsanghavi · 2020-07-01T23:51:42Z

cirq/ops/common_gates.py

+
+        The `controlled` method of the `Gate` class, of which this class is a
+        child, returns a `ControlledGate`. This method overrides this behavior
+        to return a `CXPowGate` or a `ControlledGate` of a `CXPowGate, when


Same as above. Also need to add ` before "," here and below.

dabacon · 2020-07-06T20:28:31Z

PTAL. Sorry I missed that you had suggested edits, so did those in my own branch :)

balopat · 2020-07-06T20:37:08Z

PTAL. Sorry I missed that you had suggested edits, so did those in my own branch :)

No worries! I just like to use the suggested edits for typos because it shows the diff better. I don't usually like it to be committed - it creates too many commits, mixes authors, etc.

balopat

LGTM

dabacon · 2020-07-06T21:48:02Z

@googlebot rescan please

)

dabacon added 2 commits July 1, 2020 16:08

Better controlled override docstrings

c159064

cleanup

7e745ef

dabacon requested a review from smitsanghavi July 1, 2020 23:15

googlebot added the cla: yes Makes googlebot stop complaining. label Jul 1, 2020