Skip to content

Commit

Permalink
improve docstring of plot_circuit_layout (#12370)
Browse files Browse the repository at this point in the history
* improve docstring of plot_circuit_layout

* "name" -> "index"
  • Loading branch information
kevinsung authored May 9, 2024
1 parent 87c14cb commit 70b36d0
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion qiskit/visualization/gate_map.py
Original file line number Diff line number Diff line change
Expand Up @@ -1122,7 +1122,13 @@ def plot_circuit_layout(circuit, backend, view="virtual", qubit_coordinates=None
Args:
circuit (QuantumCircuit): Input quantum circuit.
backend (Backend): Target backend.
view (str): Layout view: either 'virtual' or 'physical'.
view (str): How to label qubits in the layout. Options:
- ``"virtual"``: Label each qubit with the index of the virtual qubit that
mapped to it.
- ``"physical"``: Label each qubit with the index of the physical qubit that it
corresponds to on the device.
qubit_coordinates (Sequence): An optional sequence input (list or array being the
most common) of 2d coordinates for each qubit. The length of the
sequence must match the number of qubits on the backend. The sequence
Expand Down

0 comments on commit 70b36d0

Please sign in to comment.