Skip to content

Commit eb4ad79

Browse files
authored
Add a docstring to testing default gate domain constant (#3047)
This was breaking my doc build for reasons I have not been able to track down.
1 parent fd62530 commit eb4ad79

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

cirq/testing/random_circuit.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
from cirq import ops, value
1818
from cirq.circuits import Circuit
19+
from cirq._doc import document
1920

2021
if TYPE_CHECKING:
2122
import cirq
@@ -33,6 +34,13 @@
3334
ops.Y: 1,
3435
ops.Z: 1
3536
}
37+
document(
38+
DEFAULT_GATE_DOMAIN,
39+
"""The default gate domain for `cirq.testing.random_circuit`.
40+
41+
This includes the gates CNOT, CZ, H, ISWAP, CZ, S, SWAP, T, X, Y,
42+
and Z gates.
43+
""")
3644

3745

3846
def random_circuit(qubits: Union[Sequence[ops.Qid], int],

0 commit comments

Comments
 (0)