Skip to content

Commit

Permalink
Adding note about skipping mypy for targets. (#11)
Browse files Browse the repository at this point in the history
Co-authored-by: Mark Elliot <123787712+mark-thm@users.noreply.github.com>
  • Loading branch information
mattlgy and mark-thm committed Aug 8, 2024
1 parent eebf62b commit df9eed1
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
)
```

0 comments on commit df9eed1

Please sign in to comment.