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

Include a py.typed marker to benefit from type annotations #77

Open
bluenote10 opened this issue Oct 15, 2024 · 0 comments
Open

Include a py.typed marker to benefit from type annotations #77

bluenote10 opened this issue Oct 15, 2024 · 0 comments

Comments

@bluenote10
Copy link

First of all, thanks a lot for writing and maintaining auraloss -- it is great to have a common package for these functions!


auraloss seems to contain reasonable type annotations, at least for a certain subset of functions.

Unfortunately, the library doesn't ship with a py.typed marker (c.f. PEP 561, which means that type checkers and IDEs don't make use of the type annotations. It would be nice to add a py.typed to really benefit from the type annotations, especially since using type checking is becoming more and more a standard.

If that would be fine I can open a PR to add it, and perhaps also integrate a type check into the CI, and extend the existing type annotations a little bit. What do you think?

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