From df9eed1c83dcc4f3d47dc382c9f323724b43f26c Mon Sep 17 00:00:00 2001 From: Matt L Date: Thu, 8 Aug 2024 07:31:54 -0400 Subject: [PATCH] Adding note about skipping mypy for targets. (#11) Co-authored-by: Mark Elliot <123787712+mark-thm@users.noreply.github.com> --- readme.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/readme.md b/readme.md index eb6c945..f0f8bfb 100644 --- a/readme.md +++ b/readme.md @@ -112,3 +112,17 @@ mypy_cli( ], ) ``` + +## Skipping Targets +Adding the `no-mypy` tag will elide type checking for that target. This is useful for targets outside of your +control that generate py_* rules, such as `compile_pip_requirements` or `py_console_script_binary`, and modules +that still need typing. + +For example: +```starlark +py_binary( + name = "no_types_yet_bin", + srcs = ["no_types_yet_main.py"], + tags = ["no-mypy"], +) +```