Small doc formatting issues (#10574)

* small doc fixes * more small changes * Update qiskit/extensions/quantum_initializer/squ.py Co-authored-by: Julien Gacon <[email protected]> * improve gate docs * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * Update qiskit/converters/circuit_to_dag.py * Update qiskit/execute_function.py * Circuits as Directed Acyclic Graphs * a quantum circuit as a Directed Acyclic Graphs (DAG * __ * Fix errant plural --------- Co-authored-by: Julien Gacon <[email protected]> Co-authored-by: Jake Lishman <[email protected]> (cherry picked from commit d3a6172)
Qiskit · Sep 22, 2023 · 12c3321 · 12c3321
1 parent e78c489
commit 12c3321
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 27 deletions.
diff --git a/qiskit/circuit/gate.py b/qiskit/circuit/gate.py
@@ -100,15 +100,15 @@ def control(
         """Return controlled version of gate. See :class:`.ControlledGate` for usage.
 
         Args:
-            num_ctrl_qubits: number of controls to add to gate (default=1)
+            num_ctrl_qubits: number of controls to add to gate (default: ``1``)
             label: optional gate label
             ctrl_state: The control state in decimal or as a bitstring
-                (e.g. '111'). If None, use 2**num_ctrl_qubits-1.
+                (e.g. ``'111'``). If ``None``, use ``2**num_ctrl_qubits-1``.
 
         Returns:
             qiskit.circuit.ControlledGate: Controlled version of gate. This default algorithm
-            uses num_ctrl_qubits-1 ancillae qubits so returns a gate of size
-            num_qubits + 2*num_ctrl_qubits - 1.
+            uses ``num_ctrl_qubits-1`` ancilla qubits so returns a gate of size
+            ``num_qubits + 2*num_ctrl_qubits - 1``.
 
         Raises:
             QiskitError: unrecognized mode or invalid ctrl_state

diff --git a/qiskit/circuit/instruction.py b/qiskit/circuit/instruction.py
@@ -460,7 +460,7 @@ def qasm(self):
         """Return a default OpenQASM string for the instruction.
 
         Derived instructions may override this to print in a
-        different format (e.g. measure q[0] -> c[0];).
+        different format (e.g. ``measure q[0] -> c[0];``).
         """
         name_param = self.name
         if self.params:

diff --git a/qiskit/converters/circuit_to_dag.py b/qiskit/converters/circuit_to_dag.py
@@ -17,7 +17,7 @@
 
 
 def circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None):
-    """Build a ``DAGCircuit`` object from a ``QuantumCircuit``.
+    """Build a :class:`.DAGCircuit` object from a :class:`.QuantumCircuit`.
 
     Args:
         circuit (QuantumCircuit): the input circuit.

diff --git a/qiskit/converters/circuit_to_dagdependency.py b/qiskit/converters/circuit_to_dagdependency.py
@@ -16,7 +16,7 @@
 
 
 def circuit_to_dagdependency(circuit, create_preds_and_succs=True):
-    """Build a ``DAGDependency`` object from a ``QuantumCircuit``.
+    """Build a ``DAGDependency`` object from a :class:`~.QuantumCircuit`.
 
     Args:
         circuit (QuantumCircuit): the input circuit.

diff --git a/qiskit/dagcircuit/__init__.py b/qiskit/dagcircuit/__init__.py
@@ -17,8 +17,8 @@
 
 .. currentmodule:: qiskit.dagcircuit
 
-DAG Circuits
-============
+Circuits as Directed Acyclic Graphs
+===================================
 
 .. autosummary::
    :toctree: ../stubs/

diff --git a/qiskit/dagcircuit/dagdependency.py b/qiskit/dagcircuit/dagdependency.py
@@ -48,7 +48,7 @@
 
 
 class DAGDependency:
-    """Object to represent a quantum circuit as a directed acyclic graph
+    """Object to represent a quantum circuit as a Directed Acyclic Graph (DAG)
     via operation dependencies (i.e. lack of commutation).
 
     The nodes in the graph are operations represented by quantum gates.
@@ -143,7 +143,7 @@ def calibrations(self):
         """Return calibration dictionary.
 
         The custom pulse definition of a given gate is of the form
-            {'gate_name': {(qubits, params): schedule}}
+        ``{'gate_name': {(qubits, params): schedule}}``.
         """
         return dict(self._calibrations)
 
@@ -530,8 +530,7 @@ def draw(self, scale=0.7, filename=None, style="color"):
                          'color' (default): color input/output/op nodes
 
         Returns:
-            Ipython.display.Image: if in Jupyter notebook and not saving to file,
-                otherwise None.
+            Ipython.display.Image: if in Jupyter notebook and not saving to file, otherwise None.
         """
         from qiskit.visualization.dag_visualization import dag_drawer
 

diff --git a/qiskit/execute_function.py b/qiskit/execute_function.py
@@ -90,18 +90,17 @@ def execute(
 
         basis_gates (list[str]):
             List of basis gate names to unroll to.
-            e.g: ``['u1', 'u2', 'u3', 'cx']``
+            e.g: ``['u1', 'u2', 'u3', 'cx']``.
             If ``None``, do not unroll.
 
         coupling_map (CouplingMap or list): Coupling map (perhaps custom) to
             target in mapping. Multiple formats are supported:
 
-            #. CouplingMap instance
-            #. list
-               Must be given as an adjacency matrix, where each entry
+            #. :class:`.CouplingMap` instance
+            #. ``list``:
+               must be given as an adjacency matrix, where each entry
                specifies all two-qubit interactions supported by backend
-               e.g:
-               ``[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]``
+               e.g: ``[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]``
 
         backend_properties (BackendProperties):
             Properties returned by a backend, including information on gate

diff --git a/qiskit/extensions/quantum_initializer/squ.py b/qiskit/extensions/quantum_initializer/squ.py
@@ -31,14 +31,14 @@
 
 
 class SingleQubitUnitary(Gate):
-    """
-    u = 2*2 unitary (given as a (complex) numpy.ndarray)
-
-    mode - determines the used decomposition by providing the rotation axes
+    """Single-qubit unitary.
 
-    up_to_diagonal - the single-qubit unitary is decomposed up to a diagonal matrix,
-                     i.e. a unitary u' is implemented such that there exists a 2*2 diagonal
-                     gate d with u = d.dot(u').
+    Args:
+            unitary_matrix: :math:`2 \times 2` unitary (given as a (complex) ``numpy.ndarray``).
+            mode: determines the used decomposition by providing the rotation axes.
+            up_to_diagonal: the single-qubit unitary is decomposed up to a diagonal matrix,
+                     i.e. a unitary :math:`U'` is implemented such that there exists a diagonal
+                     matrix :math:`D` with :math:`U = D U'`.
     """
 
     def __init__(self, unitary_matrix, mode="ZYZ", up_to_diagonal=False):

diff --git a/qiskit/visualization/pass_manager_visualization.py b/qiskit/visualization/pass_manager_visualization.py
@@ -31,7 +31,7 @@ def pass_manager_drawer(pass_manager, filename=None, style=None, raw=False):
     """
     Draws the pass manager.
 
-    This function needs `pydot <https://github.com/erocarrera/pydot>`__, which in turn needs
+    This function needs `pydot <https://github.com/pydot/pydot>`__, which in turn needs
     `Graphviz <https://www.graphviz.org/>`__ to be installed.
 
     Args: