Skip to content

Commit 5f35408

Browse files
Strilanctomirendonickdgardner
authored
Fix some doc typos (#721)
Merges #667 and #693 but fixes that they edited the generated docs instead of the source. --------- Co-authored-by: Yotam Vaknin <tomirendo@gmail.com> Co-authored-by: nickdgardner <36652026+nickdgardner@users.noreply.github.com>
1 parent ca1fbc3 commit 5f35408

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

dev/gen_stim_stub_file.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ def main():
1818
version = "v" + version
1919
print(f'''
2020
"""Stim {version}: a fast quantum stabilizer circuit library."""
21-
# (This a stubs file describing the classes and methods in stim.)
21+
# (This is a stubs file describing the classes and methods in stim.)
2222
from __future__ import annotations
2323
from typing import overload, TYPE_CHECKING, List, Dict, Tuple, Any, Union, Iterable, Optional
2424
if TYPE_CHECKING:

doc/python_api_reference_vDev.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1538,7 +1538,7 @@ def detector_error_model(
15381538
error mechanisms). When set to true, the probabilities of the disjoint
15391539
cases are instead assumed to be independent probabilities. For example,
15401540
a `PAULI_CHANNEL_1(0.1, 0.2, 0.0)` becomes equivalent to an
1541-
`X_ERROR(0.1)` followed by a `Z_ERROR(0.2)`. This assumption is an
1541+
`X_ERROR(0.1)` followed by a `Y_ERROR(0.2)`. This assumption is an
15421542
approximation, but it is a good approximation for small probabilities.
15431543
15441544
This argument can also be set to a probability between 0 and 1, setting
@@ -2385,7 +2385,7 @@ def likeliest_error_sat_problem(
23852385
wcnf = WCNF(from_string="p wcnf 1 2 3\n3 -1 0\n3 1 0\n")
23862386
23872387
with RC2(wcnf) as rc2:
2388-
print(rc2.compute())
2388+
print(rc2.compute())
23892389
print(rc2.cost)
23902390
23912391
Much faster solvers are available online. For example, you can download
@@ -2772,7 +2772,7 @@ def shortest_error_sat_problem(
27722772
wcnf = WCNF(from_string="p wcnf 1 2 3\n3 -1 0\n3 1 0\n")
27732773
27742774
with RC2(wcnf) as rc2:
2775-
print(rc2.compute())
2775+
print(rc2.compute())
27762776
print(rc2.cost)
27772777
27782778
Much faster solvers are available online. For example, you can download

doc/stim.pyi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Stim (Development Version): a fast quantum stabilizer circuit library."""
2-
# (This a stubs file describing the classes and methods in stim.)
2+
# (This is a stubs file describing the classes and methods in stim.)
33
from __future__ import annotations
44
from typing import overload, TYPE_CHECKING, List, Dict, Tuple, Any, Union, Iterable, Optional
55
if TYPE_CHECKING:
@@ -958,7 +958,7 @@ class Circuit:
958958
error mechanisms). When set to true, the probabilities of the disjoint
959959
cases are instead assumed to be independent probabilities. For example,
960960
a `PAULI_CHANNEL_1(0.1, 0.2, 0.0)` becomes equivalent to an
961-
`X_ERROR(0.1)` followed by a `Z_ERROR(0.2)`. This assumption is an
961+
`X_ERROR(0.1)` followed by a `Y_ERROR(0.2)`. This assumption is an
962962
approximation, but it is a good approximation for small probabilities.
963963
964964
This argument can also be set to a probability between 0 and 1, setting

glue/python/src/stim/__init__.pyi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Stim (Development Version): a fast quantum stabilizer circuit library."""
2-
# (This a stubs file describing the classes and methods in stim.)
2+
# (This is a stubs file describing the classes and methods in stim.)
33
from __future__ import annotations
44
from typing import overload, TYPE_CHECKING, List, Dict, Tuple, Any, Union, Iterable, Optional
55
if TYPE_CHECKING:
@@ -958,7 +958,7 @@ class Circuit:
958958
error mechanisms). When set to true, the probabilities of the disjoint
959959
cases are instead assumed to be independent probabilities. For example,
960960
a `PAULI_CHANNEL_1(0.1, 0.2, 0.0)` becomes equivalent to an
961-
`X_ERROR(0.1)` followed by a `Z_ERROR(0.2)`. This assumption is an
961+
`X_ERROR(0.1)` followed by a `Y_ERROR(0.2)`. This assumption is an
962962
approximation, but it is a good approximation for small probabilities.
963963
964964
This argument can also be set to a probability between 0 and 1, setting

src/stim/circuit/circuit.pybind.cc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1704,7 +1704,7 @@ void stim_pybind::pybind_circuit_methods(pybind11::module &, pybind11::class_<Ci
17041704
error mechanisms). When set to true, the probabilities of the disjoint
17051705
cases are instead assumed to be independent probabilities. For example,
17061706
a `PAULI_CHANNEL_1(0.1, 0.2, 0.0)` becomes equivalent to an
1707-
`X_ERROR(0.1)` followed by a `Z_ERROR(0.2)`. This assumption is an
1707+
`X_ERROR(0.1)` followed by a `Y_ERROR(0.2)`. This assumption is an
17081708
approximation, but it is a good approximation for small probabilities.
17091709
17101710
This argument can also be set to a probability between 0 and 1, setting
@@ -2091,7 +2091,7 @@ void stim_pybind::pybind_circuit_methods(pybind11::module &, pybind11::class_<Ci
20912091
wcnf = WCNF(from_string="p wcnf 1 2 3\n3 -1 0\n3 1 0\n")
20922092
20932093
with RC2(wcnf) as rc2:
2094-
print(rc2.compute())
2094+
print(rc2.compute())
20952095
print(rc2.cost)
20962096
20972097
Much faster solvers are available online. For example, you can download
@@ -2166,7 +2166,7 @@ void stim_pybind::pybind_circuit_methods(pybind11::module &, pybind11::class_<Ci
21662166
wcnf = WCNF(from_string="p wcnf 1 2 3\n3 -1 0\n3 1 0\n")
21672167
21682168
with RC2(wcnf) as rc2:
2169-
print(rc2.compute())
2169+
print(rc2.compute())
21702170
print(rc2.cost)
21712171
21722172
Much faster solvers are available online. For example, you can download

0 commit comments

Comments
 (0)