Improve documentation.

CQCL · Jan 10, 2025 · 31902d6 · 31902d6
1 parent 5eb67ea
commit 31902d6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/pytket/binders/passes.cpp b/pytket/binders/passes.cpp
@@ -681,7 +681,9 @@ PYBIND11_MODULE(passes, m) {
       "A pass to remove all barrier instructions from the circuit.");
   m.def(
       "RemovePhaseOps", &RemovePhaseOps,
-      "A pass to remove all Phase operations from the circuit.");
+      "A pass to remove all Phase operations from the circuit. This includes "
+      "conditional Phase operations, but not Phase operations inside "
+      "CircBoxes, QControlBoxes or other nested structures.");
   m.def(
       "ZXGraphlikeOptimisation", &ZXGraphlikeOptimisation,
       "Attempt to optimise the circuit by simplifying in ZX calculus and "

diff --git a/pytket/pytket/_tket/passes.pyi b/pytket/pytket/_tket/passes.pyi
@@ -620,7 +620,7 @@ def RemoveImplicitQubitPermutation() -> BasePass:
     """
 def RemovePhaseOps() -> BasePass:
     """
-    A pass to remove all Phase operations from the circuit.
+    A pass to remove all Phase operations from the circuit. This includes conditional Phase operations, but not Phase operations inside CircBoxes, QControlBoxes or other nested structures.
     """
 def RemoveRedundancies() -> BasePass:
     """