-
Notifications
You must be signed in to change notification settings - Fork 50
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Project is missing py.typed marker #219
Comments
Welcome to this project and thank you!' first issue |
Is my understanding correct that mypy wants some kind of marker to allow static type checking of the package? I see that warning comes from Ansible, so that suggests Mkdocs lives in an industrialized deployment environment. Consider that I don't know everything about this field. Could I ask you to give me more context, so that I better understand why |
@fralau This scenario occurs when a developer has The warning will be raised by https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages As the page above says:
|
This adds a `py.typed` file in the package directory, which acts as a marker to declare that it is PEP 561 compliant and includes type hints. More information is available here: https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages Fixes fralau#219.
When adding the package, mypy complains about missing type marker.
This can easily be sorted by just adding the
py.typed
inside the package, even before the full types are adopted by the project.The text was updated successfully, but these errors were encountered: