Fixed escape chars in docs, removed tutorials, updated tutorial and h…

…owtos
qiskit-community · Aug 29, 2024 · 53daf6f · 53daf6f
1 parent 0b01428
commit 53daf6f
Show file tree

Hide file tree

Showing 14 changed files with 185 additions and 452 deletions.
diff --git a/docs/how_tos/1-how-to-create-codes.ipynb b/docs/how_tos/1-how-to-create-codes.ipynb
diff --git a/docs/how_tos/2-how-to-work-with-shape-objects.ipynb b/docs/how_tos/2-how-to-work-with-shape-objects.ipynb
diff --git a/docs/tutorials/1-tutorial-example.ipynb b/docs/tutorials/1-tutorial-example.ipynb
diff --git a/docs/tutorials/QEC_Framework_IEEE_2022.ipynb b/docs/tutorials/QEC_Framework_IEEE_2022.ipynb
diff --git a/docs/tutorials/how-to-use-union-find.ipynb b/docs/tutorials/how-to-use-union-find.ipynb
diff --git a/src/qiskit_qec/codes/codebuilders/surface_code_builder.py b/src/qiskit_qec/codes/codebuilders/surface_code_builder.py
@@ -38,7 +38,7 @@ def __init__(
         dz: Optional[int] = None,
         ul_op: Optional[Pauli] = Pauli("Z"),
     ) -> None:
-        """Initializes a surface code builder
+        r"""Initializes a surface code builder
 
         If d is specified then dx and dz are ignored.
 

diff --git a/src/qiskit_qec/codes/codebuilders/triangular_color_code_builder.py b/src/qiskit_qec/codes/codebuilders/triangular_color_code_builder.py
@@ -26,7 +26,7 @@ class TriangularColorCodeBuilder(Builder):
 
     # pylint: disable=anomalous-backslash-in-string
     def __init__(self, d: int) -> None:
-        """Initializes a triangular color code builder
+        r"""Initializes a triangular color code builder
 
         Example:d=3
                         o

diff --git a/src/qiskit_qec/geometry/tiles/checkerboardtile.py b/src/qiskit_qec/geometry/tiles/checkerboardtile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class CheckerBoardTile(Tile):
-    """Checker Board Tile
+    r"""Checker Board Tile
 
     The diagram is as follows::
 

diff --git a/src/qiskit_qec/geometry/tiles/diagonalbartile.py b/src/qiskit_qec/geometry/tiles/diagonalbartile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class DiagonalBarTile(Tile):
-    """Diagonal Bar Tile
+    r"""Diagonal Bar Tile
     The diagram is as follows::
 
         q0           q1     q1           q2

diff --git a/src/qiskit_qec/geometry/tiles/hexagontile.py b/src/qiskit_qec/geometry/tiles/hexagontile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class HexagonTile(Tile):
-    """Hexagon Tile
+    r"""Hexagon Tile
 
     Weight 6 operators (0,1,2)::
 

diff --git a/src/qiskit_qec/geometry/tiles/octasquaretile.py b/src/qiskit_qec/geometry/tiles/octasquaretile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class OctaSquareTile(Tile):
-    """Octa-Square Tile
+    r"""Octa-Square Tile
 
     The tile has the following structure::
 

diff --git a/src/qiskit_qec/geometry/tiles/squarediamondtile.py b/src/qiskit_qec/geometry/tiles/squarediamondtile.py
@@ -22,7 +22,7 @@
 
 # pylint: disable=anomalous-backslash-in-string)
 class SquareDiamondTile(Tile):
-    """Square Diamond Tile (Square or non-Rotated orientation)
+    r"""Square Diamond Tile (Square or non-Rotated orientation)
 
     The follow labelling is used::
 

diff --git a/src/qiskit_qec/operators/pauli.py b/src/qiskit_qec/operators/pauli.py
@@ -70,9 +70,6 @@ def __init__(
                 Defaults to 'zx'
             num_qubits (int, optional): Number of qubits to use in Pauli. Defaults to None.
 
-
-
-
         Raises:
             QiskitError: Something went wrong.
 

diff --git a/src/qiskit_qec/operators/pauli_list.py b/src/qiskit_qec/operators/pauli_list.py
@@ -27,7 +27,7 @@
 
 
 class PauliList(BasePauli, LinearMixin, GroupMixin):
-    """`PauliList` inherits from `BasePauli`"""
+    r"""`PauliList` inherits from `BasePauli`"""
 
     # Set the max number of qubits * paulis before string truncation
     _truncate__ = 2000
@@ -44,7 +44,7 @@ def __init__(
         num_qubits: Optional[int] = None,
         fast_load: bool = True,
     ) -> None:
-        """Inits a PauliList
+        r"""Inits a PauliList
 
         Args:
             data (BasePauli, np.ndarray, Tuple[np.ndarray], Iterable, None): List of Pauli Operators.
-Original file line number
+Diff line change
@@ Expand Up / @@ -70,9 +70,6 @@ def __init__( @@
                     Defaults to 'zx'
                 num_qubits (int, optional): Number of qubits to use in Pauli. Defaults to None.
             Raises:
                 QiskitError: Something went wrong.
@@ Expand Down @@