Allow partial kwargs in mpl_draw (#1180)

* Allow partial kwargs in mpl_draw * Add release note as well
Qiskit · Apr 30, 2024 · cc2c396 · cc2c396
1 parent 8642906
commit cc2c396
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/releasenotes/notes/fix-mpl-draw-kargs-typing-6cf7cfde0db072d5.yaml b/releasenotes/notes/fix-mpl-draw-kargs-typing-6cf7cfde0db072d5.yaml
@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    Fixed a bug in the type hint for the :func:`~rustworkx.visualization.mpl_draw`.
+    Previously, all `kwargs` were required when calling the method. The new annotation
+    accepts `kwargs` with partial arguments.
diff --git a/rustworkx/visualization/matplotlib.pyi b/rustworkx/visualization/matplotlib.pyi
@@ -20,7 +20,7 @@ if typing.TYPE_CHECKING:
 _S = typing.TypeVar("_S")
 _T = typing.TypeVar("_T")
 
-class _DrawKwargs(typing.TypedDict):
+class _DrawKwargs(typing.TypedDict, total=False):
     arrowstyle: str
     arrow_size: int
     node_list: list[int]