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.

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

Annotate code with type hints #232

Open
lvaylet opened this issue Apr 12, 2022 · 2 comments · Fixed by #239
Open

Annotate code with type hints #232

lvaylet opened this issue Apr 12, 2022 · 2 comments · Fixed by #239
Assignees
Labels
feature New feature or request good first issue Good for newcomers

Comments

@lvaylet
Copy link
Collaborator

lvaylet commented Apr 12, 2022

Type hints help catch certain errors, document the code base, help static analyzers (like mypy or Google's pytype) and linters in IDEs, and let us build and maintain a cleaner architecture overall.

Annotations can be done iteratively over multiple, small Pull Requests, based on the docstrings already in place. Type hints can be tested with local installations of mypi or pytype until these static analyzers are integrated in the CI pipelines.

See https://docs.python.org/3/library/typing.html for more details.

@lvaylet lvaylet added feature New feature or request good first issue Good for newcomers labels Apr 12, 2022
@lvaylet lvaylet self-assigned this Apr 12, 2022
@lvaylet lvaylet reopened this Oct 23, 2022
@lvaylet
Copy link
Collaborator Author

lvaylet commented Oct 23, 2022

Reopening so we get a chance to add more type hints.

@Thakor-Yashpal
Copy link

"Can I work on this issue?"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request good first issue Good for newcomers
Projects
None yet
2 participants