Updated docstring for generate_mirror_circuits (#2353)

* Updated docstring for generate_mirror_circuits to reflect accurate return types * Clarify meaning of `correct bitstring`
unitaryfund · May 8, 2024 · 2ff8134 · 2ff8134
1 parent 1aaa054
commit 2ff8134
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/mitiq/benchmarks/mirror_circuits.py b/mitiq/benchmarks/mirror_circuits.py
@@ -149,7 +149,8 @@ def generate_mirror_circuit(
             ``cirq.Circuit``.
 
     Returns:
-        A randomized mirror circuit.
+        A randomized mirror circuit and the bitstring corresponding
+        to a noise free result.
     """
     if not 0 <= two_qubit_gate_prob <= 1:
         raise ValueError("two_qubit_gate_prob must be between 0 and 1")