fix docstring

quantumlib · Mar 16, 2024 · 0a37469 · 0a37469
1 parent 379ef48
commit 0a37469
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 20 deletions.
diff --git a/doc/python_api_reference_vDev.md b/doc/python_api_reference_vDev.md
@@ -2407,8 +2407,8 @@ def likeliest_error_sat_problem(
             solvers slower.
 
     Returns:
-        A string corresponding to the contents of a WCNF file in the requested
-        format.
+        A string corresponding to the contents of a maxSAT problem file in the
+        requested format.
 
     Examples:
         >>> import stim
@@ -2420,7 +2420,7 @@ def likeliest_error_sat_problem(
         ...   M 0
         ...   DETECTOR rec[-1] rec[-2]
         ... """)
-        >>> print(circuit.likeliest_error_problem_as_wcnf_file(
+        >>> print(circuit.likeliest_error_sat_problem(
         ...   quantization=1000
         ... ), end='')
         p wcnf 2 4 4001
@@ -2788,8 +2788,8 @@ def shortest_error_sat_problem(
             described here: http://www.maxhs.org/docs/wdimacs.html
 
     Returns:
-        A string corresponding to the contents of a WCNF file in the requested
-        format.
+        A string corresponding to the contents of a maxSAT problem file in the
+        requested format.
 
     Examples:
 

diff --git a/doc/stim.pyi b/doc/stim.pyi
@@ -1776,8 +1776,8 @@ class Circuit:
                 solvers slower.
 
         Returns:
-            A string corresponding to the contents of a WCNF file in the requested
-            format.
+            A string corresponding to the contents of a maxSAT problem file in the
+            requested format.
 
         Examples:
             >>> import stim
@@ -1789,7 +1789,7 @@ class Circuit:
             ...   M 0
             ...   DETECTOR rec[-1] rec[-2]
             ... """)
-            >>> print(circuit.likeliest_error_problem_as_wcnf_file(
+            >>> print(circuit.likeliest_error_sat_problem(
             ...   quantization=1000
             ... ), end='')
             p wcnf 2 4 4001
@@ -2094,8 +2094,8 @@ class Circuit:
                 described here: http://www.maxhs.org/docs/wdimacs.html
 
         Returns:
-            A string corresponding to the contents of a WCNF file in the requested
-            format.
+            A string corresponding to the contents of a maxSAT problem file in the
+            requested format.
 
         Examples:
 

diff --git a/glue/python/src/stim/__init__.pyi b/glue/python/src/stim/__init__.pyi
@@ -1776,8 +1776,8 @@ class Circuit:
                 solvers slower.
 
         Returns:
-            A string corresponding to the contents of a WCNF file in the requested
-            format.
+            A string corresponding to the contents of a maxSAT problem file in the
+            requested format.
 
         Examples:
             >>> import stim
@@ -1789,7 +1789,7 @@ class Circuit:
             ...   M 0
             ...   DETECTOR rec[-1] rec[-2]
             ... """)
-            >>> print(circuit.likeliest_error_problem_as_wcnf_file(
+            >>> print(circuit.likeliest_error_sat_problem(
             ...   quantization=1000
             ... ), end='')
             p wcnf 2 4 4001
@@ -2094,8 +2094,8 @@ class Circuit:
                 described here: http://www.maxhs.org/docs/wdimacs.html
 
         Returns:
-            A string corresponding to the contents of a WCNF file in the requested
-            format.
+            A string corresponding to the contents of a maxSAT problem file in the
+            requested format.
 
         Examples:
 

diff --git a/src/stim/circuit/circuit.pybind.cc b/src/stim/circuit/circuit.pybind.cc
@@ -2108,8 +2108,8 @@ void stim_pybind::pybind_circuit_methods(pybind11::module &, pybind11::class_<Ci
                     described here: http://www.maxhs.org/docs/wdimacs.html
 
             Returns:
-                A string corresponding to the contents of a WCNF file in the requested
-                format.
+                A string corresponding to the contents of a maxSAT problem file in the
+                requested format.
 
             Examples:
 
@@ -2191,8 +2191,8 @@ void stim_pybind::pybind_circuit_methods(pybind11::module &, pybind11::class_<Ci
                     solvers slower.
 
             Returns:
-                A string corresponding to the contents of a WCNF file in the requested
-                format.
+                A string corresponding to the contents of a maxSAT problem file in the
+                requested format.
 
             Examples:
                 >>> import stim
@@ -2204,7 +2204,7 @@ void stim_pybind::pybind_circuit_methods(pybind11::module &, pybind11::class_<Ci
                 ...   M 0
                 ...   DETECTOR rec[-1] rec[-2]
                 ... """)
-                >>> print(circuit.likeliest_error_problem_as_wcnf_file(
+                >>> print(circuit.likeliest_error_sat_problem(
                 ...   quantization=1000
                 ... ), end='')
                 p wcnf 2 4 4001