modified annotated docstring for consistency

gluonhiggs · Jan 30, 2025 · 00d62f1 · 00d62f1
1 parent 64f3d22
commit 00d62f1
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 37 deletions.
diff --git a/mitiq/cdr/cdr.py b/mitiq/cdr/cdr.py
@@ -34,63 +34,81 @@
 class ExecuteWithCdrKwargs(TypedDict):
     method_select: Annotated[
         str,
-        "Specifies the method used to select the \
-        non-Clifford gates to replace when constructing the near-Clifford \
-        training circuits. Can be 'uniform' or 'gaussian'.",
+        """
+        Specifies the method used to select the
+        non-Clifford gates to replace when constructing the near-Clifford
+        training circuits. Can be 'uniform' or 'gaussian'.
+        """,
     ]
     method_replace: Annotated[
         str,
-        "Specifies the method used to replace the \
-        selected non-Clifford gates with a Clifford when constructing the \
-        near-Clifford training circuits. Can be 'uniform', 'gaussian', or \
-        'closest'.",
+        """
+        Specifies the method used to replace the
+        selected non-Clifford gates with a Clifford when constructing the
+        near-Clifford training circuits. Can be 'uniform', 'gaussian', or
+        'closest'.
+        """,
     ]
     sigma_select: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_select='gaussian'.",
+        """
+        Width of the Gaussian distribution used for
+        ``method_select='gaussian'``.
+        """,
     ]
     sigma_replace: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_replace='gaussian'.",
+        """
+        Width of the Gaussian distribution used
+        for ``method_replace='gaussian'``.
+        """,
     ]
     random_state: Annotated[int, "Seed for sampling."]
 
 
 class MitigateExecutorKwargs(TypedDict):
     method_select: Annotated[
         str,
-        "Specifies the method used to select the \
-        non-Clifford gates to replace when constructing the near-Clifford \
-        training circuits. Can be 'uniform' or 'gaussian'.",
+        """
+        Specifies the method used to select the
+        non-Clifford gates to replace when constructing the near-Clifford
+        training circuits. Can be 'uniform' or 'gaussian'.
+        """,
     ]
     method_replace: Annotated[
         str,
-        "Specifies the method used to replace the \
-        selected non-Clifford gates with a Clifford when constructing the \
-        near-Clifford training circuits. Can be 'uniform', 'gaussian', or \
-        'closest'.",
+        """
+        Specifies the method used to replace the
+        selected non-Clifford gates with a Clifford when constructing the
+        near-Clifford training circuits. Can be 'uniform', 'gaussian', or
+        'closest'.
+        """,
     ]
     sigma_select: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_select='gaussian'.",
+        """
+        Width of the Gaussian distribution used for
+        method_select='gaussian'.
+        """,
     ]
     sigma_replace: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_replace='gaussian'.",
+        """
+        Width of the Gaussian distribution used for
+        method_replace='gaussian'.
+        """,
     ]
     random_state: Annotated[int, "Seed for sampling."]
 
 
 class CdrDecoratorKwargs(TypedDict):
     method_select: Annotated[
         str,
-        "Specifies the method used to select the \
-        non-Clifford gates to replace when constructing the near-Clifford \
-        training circuits. Can be 'uniform' or 'gaussian'.",
+        """
+        Specifies the method used to select the
+        non-Clifford gates to replace when constructing the near-Clifford
+        training circuits. Can be 'uniform' or 'gaussian'.
+        """,
     ]
     method_replace: Annotated[
         str,
@@ -101,13 +119,17 @@ class CdrDecoratorKwargs(TypedDict):
     ]
     sigma_select: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_select='gaussian'.",
+        """
+        Width of the Gaussian distribution used for
+        ``method_select='gaussian'``.
+        """,
     ]
     sigma_replace: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_replace='gaussian'.",
+        """
+        Width of the Gaussian distribution used
+        for ``method_replace='gaussian'``.
+        """,
     ]
     random_state: Annotated[int, "Seed for sampling."]
 

diff --git a/mitiq/cdr/clifford_training_data.py b/mitiq/cdr/clifford_training_data.py
@@ -32,26 +32,34 @@
 class GenerateTrainingCircuitsKwargs(TypedDict):
     sigma_select: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_select='gaussian'",
+        """
+        Width of the Gaussian distribution used for
+        method_select='gaussian'
+        """,
     ]
     sigma_replace: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_replace='gaussian'",
+        """
+        Width of the Gaussian distribution used for
+        method_replace='gaussian'
+        """,
     ]
 
 
 class _MapToNearCliffordKwargs(TypedDict):
     sigma_select: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_select='gaussian'",
+        """
+        Width of the Gaussian distribution used for 
+        method_select='gaussian'
+        """,
     ]
     sigma_replace: Annotated[
         float,
-        "Width of the Gaussian distribution used for \
-        method_replace='gaussian'",
+        """
+        Width of the Gaussian distribution used for
+        method_replace='gaussian'
+        """,
     ]