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

Type hints for Python functions #162

Open
PicoCentauri opened this issue Feb 26, 2023 · 1 comment
Open

Type hints for Python functions #162

PicoCentauri opened this issue Feb 26, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Python Issues related to the Python API

Comments

@PicoCentauri
Copy link
Collaborator

Type hints are useful for new users to understand what functions are doing and also help during the development because IDE's and linters can use this information to help the developer.

Currentlty, many functions miss these type hints and we should add them.

@PicoCentauri PicoCentauri added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 26, 2023
@Luthaf
Copy link
Owner

Luthaf commented Feb 28, 2023

If we add type hints, we should also add mypy (or another checker) to check that code using these types hint is correctly doing so (I don't think mypy can check if the type hints themselves are correct, although that would be great as well!)

@Luthaf Luthaf added the Python Issues related to the Python API label Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Python Issues related to the Python API
Projects
None yet
Development

No branches or pull requests

2 participants