Skip to content

Commit a8041f5

Browse files
Update static_type_checking.md (Azure#27912)
1 parent 2c476de commit a8041f5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/dev/static_type_checking.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ given the expressiveness of Python as a language. So, in practice, what should y
109109
type checker, follow the steps per [PEP 561](https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages) below:
110110

111111
- add an empty `py.typed` file to your package directory. E.g. `.../sdk/azure-core/azure/core/py.typed`
112-
- include the `py.typed` file in the
112+
- include the path to the `py.typed` in the
113113
MANIFEST.in ([example](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/MANIFEST.in)).
114114
This is important as it ensures the `py.typed` is included in both the sdist/bdist.
115-
- include `py.typed` under `package_data` in your setup.py (`package_data={"azure.core": ["py.typed"]}`).
115+
- set `include_package_data=True` and `package_data={"azure.core": ["py.typed"]}` in the setup.py.
116116
Note that the key should be the namespace of where the `py.typed` file is found.
117117

118118
2) Add type hints anywhere in the source code where unit tests are worth writing. Consider typing/mypy as "free" tests

0 commit comments

Comments
 (0)