Please add py.typed so mypy will use and respect type annotations in …

…mistune (#348) feat: add py.typed for mypy
lepture · Jun 9, 2023 · 8df3d1c · 8df3d1c
1 parent 4222ee1
commit 8df3d1c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/setup.py b/setup.py
@@ -4,4 +4,5 @@
 
 setup(
     name="mistune",
+    package_data={"mistune": ["py.typed", ]}
 )
diff --git a/src/mistune/py.typed b/src/mistune/py.typed
@@ -0,0 +1,2 @@
+# when type checking dependents, tell type checkers, e.g. mypy, to use this package's types
+# without this file, mypy will write a warning and ignore type annotations from mistune.