Adding documentation for the new to_CNF parameter.

QuMuLab · Dec 12, 2022 · a025fdd · a025fdd
1 parent 4a63b50
commit a025fdd
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/nnf/__init__.py b/nnf/__init__.py
@@ -575,7 +575,10 @@ def neg(node: NNF) -> NNF:
         return neg(self)
 
     def to_CNF(self, simplify: bool = True) -> 'And[Or[Var]]':
-        """Compile theory to a semantically equivalent CNF formula."""
+        """Compile theory to a semantically equivalent CNF formula.
+
+        :param simplify: If True, simplify clauses even if that means
+                     eliminating variables."""
         return tseitin.to_CNF(self, simplify)
 
     def _cnf_satisfiable(self) -> bool: