Merge pull request #175 from dlyongemallo/graph_to_swaps_docstring

Make the docstring for `graph_to_swaps` a bit clearer.
zxcalc · Oct 30, 2023 · 4278d18 · 4278d18
2 parents 5beb9bc + 417be1d
commit 4278d18
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/pyzx/extract.py b/pyzx/extract.py
@@ -780,8 +780,9 @@ def extract_simple(g: BaseGraph[VT, ET], up_to_perm: bool = True) -> Circuit:
 
 
 def graph_to_swaps(g: BaseGraph[VT, ET], no_swaps: bool = False) -> Circuit:
-    """Converts a graph containing only normal and Hadamard edges into a circuit of Hadamard
-    and SWAP gates. If 'no_swaps' is True, only add Hadamards where needed"""
+    """Converts a graph containing only normal and Hadamard edges (i.e., no vertices other than
+    inputs and outputs) into a circuit of Hadamard and SWAP gates. If 'no_swaps' is True, only add
+    Hadamards where needed"""
     swap_map = {}
     leftover_swaps = False
     inputs = g.inputs()