Change return type of CircuitRepeatBlock.name to str (#783)

The correct return type for this method should be `str` as the documentation guarantees that this specific method returns `"REPEAT"`. Derived from #777 Fixes #776 --------- Co-authored-by: Adrien Suau <[email protected]>
quantumlib · Jun 11, 2024 · 2b3b645 · 2b3b645
1 parent 320288c
commit 2b3b645
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/doc/python_api_reference_vDev.md b/doc/python_api_reference_vDev.md
@@ -3797,7 +3797,7 @@ def body_copy(
 @property
 def name(
     self,
-) -> object:
+) -> str:
     """Returns the name "REPEAT".
 
     This is a duck-typing convenience method. It exists so that code that doesn't

diff --git a/doc/stim.pyi b/doc/stim.pyi
@@ -2840,7 +2840,7 @@ class CircuitRepeatBlock:
     @property
     def name(
         self,
-    ) -> object:
+    ) -> str:
         """Returns the name "REPEAT".
 
         This is a duck-typing convenience method. It exists so that code that doesn't

diff --git a/glue/python/src/stim/__init__.pyi b/glue/python/src/stim/__init__.pyi
@@ -2840,7 +2840,7 @@ class CircuitRepeatBlock:
     @property
     def name(
         self,
-    ) -> object:
+    ) -> str:
         """Returns the name "REPEAT".
 
         This is a duck-typing convenience method. It exists so that code that doesn't

diff --git a/src/stim/circuit/circuit_repeat_block.pybind.cc b/src/stim/circuit/circuit_repeat_block.pybind.cc
@@ -107,7 +107,7 @@ void stim_pybind::pybind_circuit_repeat_block_methods(pybind11::module &m, pybin
 
     c.def_property_readonly(
         "name",
-        [](const CircuitRepeatBlock &self) -> pybind11::object {
+        [](const CircuitRepeatBlock &self) -> pybind11::str {
             return pybind11::cast("REPEAT");
         },
         clean_doc_string(R"DOC(