Skip to content

Commit 1366494

Browse files
authoredSep 18, 2023
Apply minor doc fixes (#6289)
- quirk_url_to_circuit and quirk_json_to_circuit had weird HTML in them. - concat_ragged had a bunch of pre tags in the output. I believe these changes fix the markdown generation.
1 parent b630298 commit 1366494

File tree

3 files changed

+57
-52
lines changed

3 files changed

+57
-52
lines changed
 

‎cirq-core/cirq/circuits/circuit.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -1465,14 +1465,14 @@ def concat_ragged(
14651465
14661466
Beware that this method is *not* associative. For example:
14671467
1468-
>>> a, b = cirq.LineQubit.range(2)
1469-
>>> A = cirq.Circuit(cirq.H(a))
1470-
>>> B = cirq.Circuit(cirq.H(b))
1471-
>>> f = cirq.Circuit.concat_ragged
1472-
>>> f(f(A, B), A) == f(A, f(B, A))
1473-
False
1474-
>>> len(f(f(f(A, B), A), B)) == len(f(f(A, f(B, A)), B))
1475-
False
1468+
>>> a, b = cirq.LineQubit.range(2)
1469+
>>> A = cirq.Circuit(cirq.H(a))
1470+
>>> B = cirq.Circuit(cirq.H(b))
1471+
>>> f = cirq.Circuit.concat_ragged
1472+
>>> f(f(A, B), A) == f(A, f(B, A))
1473+
False
1474+
>>> len(f(f(f(A, B), A), B)) == len(f(f(A, f(B, A)), B))
1475+
False
14761476
14771477
Args:
14781478
*circuits: The circuits to concatenate.

‎cirq-core/cirq/interop/quirk/url_to_circuit.py

+40-38
Original file line numberDiff line numberDiff line change
@@ -77,39 +77,40 @@ def quirk_url_to_circuit(
7777
a billion laughs attack in the form of nested custom gates.
7878
7979
Examples:
80-
>>> print(cirq.quirk_url_to_circuit(
81-
... 'http://algassert.com/quirk#circuit={"cols":[["H"],["•","X"]]}'
82-
... ))
83-
0: ───H───@───
84-
85-
1: ───────X───
86-
87-
>>> print(cirq.quirk_url_to_circuit(
88-
... 'http://algassert.com/quirk#circuit={"cols":[["H"],["•","X"]]}',
89-
... qubits=[cirq.NamedQubit('Alice'), cirq.NamedQubit('Bob')]
90-
... ))
91-
Alice: ───H───@───
92-
93-
Bob: ─────────X───
94-
95-
>>> print(cirq.quirk_url_to_circuit(
96-
... 'http://algassert.com/quirk#circuit={"cols":[["iswap"]]}',
97-
... extra_cell_makers={'iswap': cirq.ISWAP}))
98-
0: ───iSwap───
99-
100-
1: ───iSwap───
101-
102-
>>> print(cirq.quirk_url_to_circuit(
103-
... 'http://algassert.com/quirk#circuit={"cols":[["iswap"]]}',
104-
... extra_cell_makers=[
105-
... cirq.interop.quirk.cells.CellMaker(
106-
... identifier='iswap',
107-
... size=2,
108-
... maker=lambda args: cirq.ISWAP(*args.qubits))
109-
... ]))
110-
0: ───iSwap───
80+
81+
>>> print(cirq.quirk_url_to_circuit(
82+
... 'http://algassert.com/quirk#circuit={"cols":[["H"],["•","X"]]}'
83+
... ))
84+
0: ───H───@───
11185
112-
1: ───iSwap───
86+
1: ───────X───
87+
88+
>>> print(cirq.quirk_url_to_circuit(
89+
... 'http://algassert.com/quirk#circuit={"cols":[["H"],["•","X"]]}',
90+
... qubits=[cirq.NamedQubit('Alice'), cirq.NamedQubit('Bob')]
91+
... ))
92+
Alice: ───H───@───
93+
94+
Bob: ─────────X───
95+
96+
>>> print(cirq.quirk_url_to_circuit(
97+
... 'http://algassert.com/quirk#circuit={"cols":[["iswap"]]}',
98+
... extra_cell_makers={'iswap': cirq.ISWAP}))
99+
0: ───iSwap───
100+
101+
1: ───iSwap───
102+
103+
>>> print(cirq.quirk_url_to_circuit(
104+
... 'http://algassert.com/quirk#circuit={"cols":[["iswap"]]}',
105+
... extra_cell_makers=[
106+
... cirq.interop.quirk.cells.CellMaker(
107+
... identifier='iswap',
108+
... size=2,
109+
... maker=lambda args: cirq.ISWAP(*args.qubits))
110+
... ]))
111+
0: ───iSwap───
112+
113+
1: ───iSwap───
113114
114115
Returns:
115116
The parsed circuit.
@@ -172,12 +173,13 @@ def quirk_json_to_circuit(
172173
a billion laughs attack in the form of nested custom gates.
173174
174175
Examples:
175-
>>> print(cirq.quirk_json_to_circuit(
176-
... {"cols":[["H"], ["•", "X"]]}
177-
... ))
178-
0: ───H───@───
179-
180-
1: ───────X───
176+
177+
>>> print(cirq.quirk_json_to_circuit(
178+
... {"cols":[["H"], ["•", "X"]]}
179+
... ))
180+
0: ───H───@───
181+
182+
1: ───────X───
181183
182184
Returns:
183185
The parsed circuit.

‎cirq-core/cirq/protocols/apply_channel_protocol.py

+9-6
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,16 @@ class ApplyChannelArgs:
4141
r"""Arguments for efficiently performing a channel.
4242
4343
A channel performs the mapping
44-
$$
45-
X \rightarrow \sum_i A_i X A_i^\dagger
46-
$$
44+
45+
$$
46+
X \rightarrow \sum_i A_i X A_i^\dagger
47+
$$
48+
4749
for operators $A_i$ that satisfy the normalization condition
48-
$$
49-
\sum_i A_i^\dagger A_i = I.
50-
$$
50+
51+
$$
52+
\sum_i A_i^\dagger A_i = I.
53+
$$
5154
5255
The receiving object is expected to mutate `target_tensor` so that it
5356
contains the density matrix after multiplication, and then return

0 commit comments

Comments
 (0)
Please sign in to comment.