Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use Python type hints instead of docstring to document types #61

Open
snazzyfox opened this issue Aug 24, 2020 · 0 comments
Open

Use Python type hints instead of docstring to document types #61

snazzyfox opened this issue Aug 24, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation meta Feedback of changes about the repo, CI, dev tooling etc, not the code

Comments

@snazzyfox
Copy link
Collaborator

Most data types are documented in docstrings. We should move them all to type hints because this will allow use to run static type checks, and as a benefit, catch undocumented variables.

Together with #60 this will allow us to enable more stringent static type checking.
@snazzyfox snazzyfox added documentation Improvements or additions to documentation meta Feedback of changes about the repo, CI, dev tooling etc, not the code labels Aug 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation meta Feedback of changes about the repo, CI, dev tooling etc, not the code
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@snazzyfox