Add type hints and update docstrings - Githubissues

chartbeat-labs / textacy

NLP, before and after spaCy

https://textacy.readthedocs.io

Other

2.21k stars 249 forks source link

Add type hints and update docstrings #289

Closed bdewilde closed 4 years ago

bdewilde commented 4 years ago

Description

Add type hints throughout (almost all of) the code base, to help users develop faster and more confidently
Add dev-only mypy dependency, for type checking

Motivation and Context

Now that textacy is PY3-only, we should probably start taking advantage of modern Python features. :)

How Has This Been Tested?

All tests pass 👍

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My code follows the code style of this project.
[x] My change requires a change to the documentation, and I have updated it accordingly.