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

[Discussion] Adding type hints? #24

Open
CruzR opened this issue Oct 5, 2018 · 0 comments
Open

[Discussion] Adding type hints? #24

CruzR opened this issue Oct 5, 2018 · 0 comments

Comments

@CruzR
Copy link

CruzR commented Oct 5, 2018

First of all, thanks for making your work available to all of us!

I'm currently working on adding type hints to a project that uses the noise package. Since most of the functions & methods in this package - especially the ones defined in extension modules - do not make use of Python's dynamic typing, it seems possible and useful to add type hints here, aswell.

PEP 561 defines how to distribute type information with a python package, the documentation for mypy gives a good summary:

  • Type hints can either be distributed inline with the python code, or
  • Type stub files can be distributed within the same package, or
  • a separate stub files package called <packagename>-stubs can be created

I'd be willing to do all the work.

If you are in favor of adding type hints to the noise package, which way would you prefer, inline or as stub files? If you're opposed to adding type hints, would you mind if I create a noise-stubs package and publish it to PyPI?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant