Skip to content

Fix stim.Circuit.append's documented signature claiming arg= is required #970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 27, 2025
Merged

Fix stim.Circuit.append's documented signature claiming arg= is required #970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44c877d
Fix `stim.Circuit.append`'s documented signature claiming `arg=` is r…
Strilanc Jun 27, 2025
fd65250
Merge branch 'main' of github.com:quantumlib/Stim into fixoptarg
Strilanc Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions doc/python_api_reference_vDev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -841,7 +841,7 @@ def append(
self,
name: str,
targets: Union[int, stim.GateTarget, stim.PauliString, Iterable[Union[int, stim.GateTarget, stim.PauliString]]],
arg: Union[float, Iterable[float]],
arg: Union[float, Iterable[float], None] = None,
*,
tag: str = "",
) -> None:
Expand All @@ -864,27 +864,6 @@ def append(

Note: `stim.Circuit.append_operation` is an alias of `stim.Circuit.append`.

Examples:
>>> import stim
>>> c = stim.Circuit()
>>> c.append("X", 0)
>>> c.append("H", [0, 1])
>>> c.append("M", [0, stim.target_inv(1)])
>>> c.append("CNOT", [stim.target_rec(-1), 0])
>>> c.append("X_ERROR", [0], 0.125)
>>> c.append("CORRELATED_ERROR", [stim.target_x(0), stim.target_y(2)], 0.25)
>>> c.append("MPP", [stim.PauliString("X1*Y2"), stim.GateTarget("Z3")])
>>> print(repr(c))
stim.Circuit('''
X 0
H 0 1
M 0 !1
CX rec[-1] 0
X_ERROR(0.125) 0
E(0.25) X0 Y2
MPP X1*Y2 Z3
''')

Args:
name: The name of the operation's gate (e.g. "H" or "M" or "CNOT").

Expand Down Expand Up @@ -916,6 +895,27 @@ def append(
`cirq.append`) will default to a single 0.0 argument for gates that
take exactly one argument.
tag: A customizable string attached to the instruction.

Examples:
>>> import stim
>>> c = stim.Circuit()
>>> c.append("X", 0)
>>> c.append("H", [0, 1])
>>> c.append("M", [0, stim.target_inv(1)])
>>> c.append("CNOT", [stim.target_rec(-1), 0])
>>> c.append("X_ERROR", [0], 0.125)
>>> c.append("CORRELATED_ERROR", [stim.target_x(0), stim.target_y(2)], 0.25)
>>> c.append("MPP", [stim.PauliString("X1*Y2"), stim.GateTarget("Z3")])
>>> print(repr(c))
stim.Circuit('''
X 0
H 0 1
M 0 !1
CX rec[-1] 0
X_ERROR(0.125) 0
E(0.25) X0 Y2
MPP X1*Y2 Z3
''')
"""
```

Expand Down
44 changes: 22 additions & 22 deletions doc/stim.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ class Circuit:
self,
name: str,
targets: Union[int, stim.GateTarget, stim.PauliString, Iterable[Union[int, stim.GateTarget, stim.PauliString]]],
arg: Union[float, Iterable[float]],
arg: Union[float, Iterable[float], None] = None,
*,
tag: str = "",
) -> None:
Expand All @@ -325,27 +325,6 @@ class Circuit:

Note: `stim.Circuit.append_operation` is an alias of `stim.Circuit.append`.

Examples:
>>> import stim
>>> c = stim.Circuit()
>>> c.append("X", 0)
>>> c.append("H", [0, 1])
>>> c.append("M", [0, stim.target_inv(1)])
>>> c.append("CNOT", [stim.target_rec(-1), 0])
>>> c.append("X_ERROR", [0], 0.125)
>>> c.append("CORRELATED_ERROR", [stim.target_x(0), stim.target_y(2)], 0.25)
>>> c.append("MPP", [stim.PauliString("X1*Y2"), stim.GateTarget("Z3")])
>>> print(repr(c))
stim.Circuit('''
X 0
H 0 1
M 0 !1
CX rec[-1] 0
X_ERROR(0.125) 0
E(0.25) X0 Y2
MPP X1*Y2 Z3
''')

Args:
name: The name of the operation's gate (e.g. "H" or "M" or "CNOT").

Expand Down Expand Up @@ -377,6 +356,27 @@ class Circuit:
`cirq.append`) will default to a single 0.0 argument for gates that
take exactly one argument.
tag: A customizable string attached to the instruction.

Examples:
>>> import stim
>>> c = stim.Circuit()
>>> c.append("X", 0)
>>> c.append("H", [0, 1])
>>> c.append("M", [0, stim.target_inv(1)])
>>> c.append("CNOT", [stim.target_rec(-1), 0])
>>> c.append("X_ERROR", [0], 0.125)
>>> c.append("CORRELATED_ERROR", [stim.target_x(0), stim.target_y(2)], 0.25)
>>> c.append("MPP", [stim.PauliString("X1*Y2"), stim.GateTarget("Z3")])
>>> print(repr(c))
stim.Circuit('''
X 0
H 0 1
M 0 !1
CX rec[-1] 0
X_ERROR(0.125) 0
E(0.25) X0 Y2
MPP X1*Y2 Z3
''')
"""
def append_from_stim_program_text(
self,
Expand Down
44 changes: 22 additions & 22 deletions glue/python/src/stim/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ class Circuit:
self,
name: str,
targets: Union[int, stim.GateTarget, stim.PauliString, Iterable[Union[int, stim.GateTarget, stim.PauliString]]],
arg: Union[float, Iterable[float]],
arg: Union[float, Iterable[float], None] = None,
*,
tag: str = "",
) -> None:
Expand All @@ -325,27 +325,6 @@ class Circuit:

Note: `stim.Circuit.append_operation` is an alias of `stim.Circuit.append`.

Examples:
>>> import stim
>>> c = stim.Circuit()
>>> c.append("X", 0)
>>> c.append("H", [0, 1])
>>> c.append("M", [0, stim.target_inv(1)])
>>> c.append("CNOT", [stim.target_rec(-1), 0])
>>> c.append("X_ERROR", [0], 0.125)
>>> c.append("CORRELATED_ERROR", [stim.target_x(0), stim.target_y(2)], 0.25)
>>> c.append("MPP", [stim.PauliString("X1*Y2"), stim.GateTarget("Z3")])
>>> print(repr(c))
stim.Circuit('''
X 0
H 0 1
M 0 !1
CX rec[-1] 0
X_ERROR(0.125) 0
E(0.25) X0 Y2
MPP X1*Y2 Z3
''')

Args:
name: The name of the operation's gate (e.g. "H" or "M" or "CNOT").

Expand Down Expand Up @@ -377,6 +356,27 @@ class Circuit:
`cirq.append`) will default to a single 0.0 argument for gates that
take exactly one argument.
tag: A customizable string attached to the instruction.

Examples:
>>> import stim
>>> c = stim.Circuit()
>>> c.append("X", 0)
>>> c.append("H", [0, 1])
>>> c.append("M", [0, stim.target_inv(1)])
>>> c.append("CNOT", [stim.target_rec(-1), 0])
>>> c.append("X_ERROR", [0], 0.125)
>>> c.append("CORRELATED_ERROR", [stim.target_x(0), stim.target_y(2)], 0.25)
>>> c.append("MPP", [stim.PauliString("X1*Y2"), stim.GateTarget("Z3")])
>>> print(repr(c))
stim.Circuit('''
X 0
H 0 1
M 0 !1
CX rec[-1] 0
X_ERROR(0.125) 0
E(0.25) X0 Y2
MPP X1*Y2 Z3
''')
"""
def append_from_stim_program_text(
self,
Expand Down
44 changes: 22 additions & 22 deletions src/stim/circuit/circuit.pybind.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1090,33 +1090,12 @@ void stim_pybind::pybind_circuit_methods(pybind11::module &, pybind11::class_<Ci
pybind11::arg("tag") = "",
k == 0 ? "[DEPRECATED] use stim.Circuit.append instead"
: clean_doc_string(R"DOC(
@overload def append(self, name: str, targets: Union[int, stim.GateTarget, stim.PauliString, Iterable[Union[int, stim.GateTarget, stim.PauliString]]], arg: Union[float, Iterable[float]], *, tag: str = "") -> None:
@overload def append(self, name: str, targets: Union[int, stim.GateTarget, stim.PauliString, Iterable[Union[int, stim.GateTarget, stim.PauliString]]], arg: Union[float, Iterable[float], None] = None, *, tag: str = "") -> None:
@overload def append(self, name: Union[stim.CircuitInstruction, stim.CircuitRepeatBlock, stim.Circuit]) -> None:
Appends an operation into the circuit.

Note: `stim.Circuit.append_operation` is an alias of `stim.Circuit.append`.

Examples:
>>> import stim
>>> c = stim.Circuit()
>>> c.append("X", 0)
>>> c.append("H", [0, 1])
>>> c.append("M", [0, stim.target_inv(1)])
>>> c.append("CNOT", [stim.target_rec(-1), 0])
>>> c.append("X_ERROR", [0], 0.125)
>>> c.append("CORRELATED_ERROR", [stim.target_x(0), stim.target_y(2)], 0.25)
>>> c.append("MPP", [stim.PauliString("X1*Y2"), stim.GateTarget("Z3")])
>>> print(repr(c))
stim.Circuit('''
X 0
H 0 1
M 0 !1
CX rec[-1] 0
X_ERROR(0.125) 0
E(0.25) X0 Y2
MPP X1*Y2 Z3
''')

Args:
name: The name of the operation's gate (e.g. "H" or "M" or "CNOT").

Expand Down Expand Up @@ -1148,6 +1127,27 @@ void stim_pybind::pybind_circuit_methods(pybind11::module &, pybind11::class_<Ci
`cirq.append`) will default to a single 0.0 argument for gates that
take exactly one argument.
tag: A customizable string attached to the instruction.

Examples:
>>> import stim
>>> c = stim.Circuit()
>>> c.append("X", 0)
>>> c.append("H", [0, 1])
>>> c.append("M", [0, stim.target_inv(1)])
>>> c.append("CNOT", [stim.target_rec(-1), 0])
>>> c.append("X_ERROR", [0], 0.125)
>>> c.append("CORRELATED_ERROR", [stim.target_x(0), stim.target_y(2)], 0.25)
>>> c.append("MPP", [stim.PauliString("X1*Y2"), stim.GateTarget("Z3")])
>>> print(repr(c))
stim.Circuit('''
X 0
H 0 1
M 0 !1
CX rec[-1] 0
X_ERROR(0.125) 0
E(0.25) X0 Y2
MPP X1*Y2 Z3
''')
)DOC")
.data());
}
Expand Down
Loading