Skip to content

Commit ff57b41

Browse files
committed
Add notes about mypy and the analyze session
1 parent 9c61876 commit ff57b41

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ documentation. Nox manages virtual environments for you, specifying Python
4242
versions and installing the the local, dynamic version of the Plant SDK for
4343
Python and required development packages.
4444

45-
Run Nox with the default sessions (same checks as CI):
45+
To run nox with the default sessions (same checks as CIi: lint, analyze, test,
46+
coverage, docs) type "nox".
4647

4748
```console
4849
$ nox
@@ -150,6 +151,16 @@ To run lint check:
150151
$ nox -s lint
151152
```
152153

154+
## Static code analysis
155+
156+
The project uses [mypy](https://mypy.readthedocs.io/en/stable/) for static
157+
analysis of code. Mypy checks for correctness of type hints and can find other
158+
type-related bugs. The nox session session that calls mypy is named analyze.
159+
160+
```console
161+
$ nox -s analyze
162+
```
163+
153164
## Documentation
154165

155166
Documentation is built from Markdown files in the `docs` directory using

0 commit comments

Comments
 (0)