Skip to content

Commit db556de

Browse files
committed
add additional set of docstrings for wrapped statements
1 parent d96905d commit db556de

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

src/bloqade/qubit/_interface.py

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,46 @@ def reset(qubits: ilist.IList[Qubit, Any]) -> None: ...
5252
@wraps(IsZero)
5353
def is_zero(
5454
measurements: ilist.IList[MeasurementResult, N],
55-
) -> ilist.IList[bool, N]: ...
55+
) -> ilist.IList[bool, N]:
56+
"""
57+
Check if each measurement result in a list corresponds to a measured value of 0.
58+
59+
Args:
60+
measurements (IList[MeasurementResult, N]): The list of measurements to check.
61+
62+
Returns:
63+
IList[bool, N]: A list of booleans indicating whether each measurement result is 0.
64+
"""
65+
66+
...
5667

5768

5869
@wraps(IsOne)
59-
def is_one(measurements: ilist.IList[MeasurementResult, N]) -> ilist.IList[bool, N]: ...
70+
def is_one(measurements: ilist.IList[MeasurementResult, N]) -> ilist.IList[bool, N]:
71+
"""
72+
Check if each measurement result in a list corresponds to a measured value of 1.
73+
74+
Args:
75+
measurements (IList[MeasurementResult, N]): The list of measurements to check.
76+
77+
Returns:
78+
IList[bool, N]: A list of booleans indicating whether each measurement result is 1.
79+
"""
80+
...
6081

6182

6283
@wraps(IsLost)
6384
def is_lost(
6485
measurements: ilist.IList[MeasurementResult, N],
65-
) -> ilist.IList[bool, N]: ...
86+
) -> ilist.IList[bool, N]:
87+
"""
88+
Check if each measurement result in a list corresponds to a lost atom.
89+
90+
Args:
91+
measurements (IList[MeasurementResult, N]): The list of measurements to check.
92+
93+
Returns:
94+
IList[bool, N]: A list of booleans indicating whether each measurement indicates the atom was lost.
95+
96+
"""
97+
...

0 commit comments

Comments
 (0)