GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-09-18 22:12:21 -04:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

request type hints in new contributions

Browse source
This commit is contained in:
Damien Elmes 2020-01-13 21:39:57 +10:00
parent 8946ad5483
commit e98327f10d
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.contributing
View file

@ -34,6 +34,8 @@ pragmatism is advised. Anki's codebase is old and of varying quality, and
there are parts that are difficult to type properly. Don't feel the need to there are parts that are difficult to type properly. Don't feel the need to
avoid 'Any' when a proper type is impractical. avoid 'Any' when a proper type is impractical.
Please use type hints in any new code that you are contributing.
When running 'make check', Anki uses mypy to typecheck the code. Mypy only When running 'make check', Anki uses mypy to typecheck the code. Mypy only
checks parts of the code that have type signatures, so adding more type checks parts of the code that have type signatures, so adding more type
signatures to the code improves code coverage. signatures to the code improves code coverage.