You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To improve our code quality we started to use mypy and docstring linters on more and more sub packages.
We are now at a point where it might be easier to those tools opt out for the packages that aren't ready, instead of opt in for the packages that we already use them on.
Currently checked sub packages:
plugin_system
utils
deprecation
testing
parameter
project
model/property.py
builtin/io/pandas
Currently NOT checked sub packages:
io (should be no problem)
typing (should be no problem)
analysis (needs type stubs and docstrings)
builtin (needs type stubs and docstrings for megacomplexes, io needs more annotations and docstrings)
cli (?)
model (needs type stubs and docstrings)
Benefits
Makes code easier to maintain
Documents the user facing API
Mypy will find a lot of problem we didn't discover yet (unused code paths)
Additional context
The text was updated successfully, but these errors were encountered:
Proposed refactoring
To improve our code quality we started to use
mypy
and docstring linters on more and more sub packages.We are now at a point where it might be easier to those tools opt out for the packages that aren't ready, instead of opt in for the packages that we already use them on.
Currently checked sub packages:
Currently NOT checked sub packages:
Benefits
Additional context
The text was updated successfully, but these errors were encountered: