Fix layers type annotations (#1341)

IvanIsCoding · web-flow · commit a9aeaef12793 · 2025-01-14T14:24:55.000Z
* Fix layers type annotations

* Add release notes
diff --git a/releasenotes/notes/fix-layers-stub-66a6e404f55967f0.yaml b/releasenotes/notes/fix-layers-stub-66a6e404f55967f0.yaml
@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    Fixed a bug in the type hint for :func:`~rustworkx.layers`
+    Refer to `issue 1340 <https://github.com/Qiskit/rustworkx/issues/1340>`__ for
+    more information.
diff --git a/rustworkx/rustworkx.pyi b/rustworkx/rustworkx.pyi
@@ -321,7 +321,7 @@ def layers(
     first_layer: list[int],
     /,
     index_output: bool = ...,
-) -> list[_S] | list[int]: ...
+) -> list[list[_S]] | list[list[int]]: ...
 @final
 class TopologicalSorter:
     def __init__(
