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

Add type annotations where useful (constructors, methods, functions, etc.) #486

Open
MatthewCaseres opened this issue Jan 18, 2024 · 1 comment
Assignees

Comments

@MatthewCaseres
Copy link
Contributor

MatthewCaseres commented Jan 18, 2024

Is your feature request related to a problem? Please describe.
When typing out arguments I want to see what I should be passing in.

Is your feature request at odds with the scope of the package?
dont think so

Describe the solution you'd like
Put type annotations so that there are minimal "Any" in this screenshot

Screenshot 2024-01-17 at 7 59 25 PM

Describe alternatives you've considered
Letting the code remain as it is.

Additional context

Currently there is no minimal version of Python in setup.py. Type annotations are from 3.5, so it might be worthwhile to add this as requirement.

Ideally the type annotation for origin_grain is Literal['Y', 'S', 'Q', 'M'], and typing.Literal is from 3.8, and 3.8 is also the earliest version that is not end of life - https://devguide.python.org/versions/. So I want to add an earliest Python version to setup.py and make it 3.8.

@genedan
Copy link
Contributor

genedan commented May 21, 2024

I'll take this one on.

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

No branches or pull requests

3 participants