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

Migration to type hints #130

Open
jawooll opened this issue Sep 30, 2022 · 2 comments
Open

Migration to type hints #130

jawooll opened this issue Sep 30, 2022 · 2 comments
Labels
discussion Point requiring discussion documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jawooll
Copy link
Contributor

jawooll commented Sep 30, 2022

With type hinting becoming both standardised and stable within the latest Python versions, maybe we should consider including type hints with the next minor release? As we support Python 3.7+ this is still ok.

It would be a rather redundant addition, going through the entire codebase and implementing the appropriate changes, but will enhance readability and keep us better aligned with PEP guidelines.

This can always be delayed to a later date too, just worth getting some thought's on this.

@jawooll jawooll added the discussion Point requiring discussion label Sep 30, 2022
@yetinam
Copy link
Member

yetinam commented Sep 30, 2022

I agree, it seems like a good idea to replace the type hints in our documentation with proper type hints. Maybe more of a long term project to progressively address? I guess slowly adding type hinting module by module shouldn't break anything.

@jawooll
Copy link
Contributor Author

jawooll commented Sep 30, 2022

Definitely, doing it in the way you suggest will break this up into more manageable chunks - sounds good 👍

@jawooll jawooll added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Point requiring discussion documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants