Skip to content

Commit 022e023

Browse files
Add get_check_qubits to api docs (#39)
* Add get_check_qubits to api docs * Fix typo in docstring
1 parent a370af5 commit 022e023

3 files changed

Lines changed: 3 additions & 1 deletion

File tree

docs/apidocs/qiskit_paulice.layout.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ Layout (:mod:`qiskit_paulice.layout`)
1010
.. currentmodule:: qiskit_paulice.layout
1111

1212
.. autofunction:: get_low_overhead_ancillas
13+
.. autofunction:: get_check_qubits

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@
137137
("qiskit_paulice.noise_models", "LayeredGateNoise"),
138138
("qiskit_paulice.noise_models", "GateWiseNoise"),
139139
("qiskit_paulice.layout", "get_low_overhead_ancillas"),
140+
("qiskit_paulice.layout", "get_check_qubits"),
140141
]
141142

142143
redirects = {

python/qiskit_paulice/layout.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def get_check_qubits(
2626
"""Pair qubits in ``layout`` with neighboring ancillas.
2727
2828
Generate equal-length lists of target and ancilla qubits, such that
29-
target qubit ``i`` is adjacent to ancilla qubit ``i``in the coupling map.
29+
target qubit ``i`` is adjacent to ancilla qubit ``i`` in the coupling map.
3030
Target and ancilla qubits may appear at most one time in their
3131
respective lists.
3232

0 commit comments

Comments
 (0)