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

plans for adding type hints #220

Open
mr-majkel opened this issue Nov 30, 2022 · 2 comments
Open

plans for adding type hints #220

mr-majkel opened this issue Nov 30, 2022 · 2 comments
Labels
feature New feature or request

Comments

@mr-majkel
Copy link

Hi, it seems that the codebase is not annotated making the discoverability of methods difficult and static code analysis not working. Any plans on adding type hints?

@markfairbanks markfairbanks added the feature New feature or request label Dec 5, 2022
@markfairbanks
Copy link
Owner

markfairbanks commented Dec 5, 2022

Type hints would probably be worth adding.

If you need to know argument types they can also be found in the documentation.

You can access this in console using

import tidypolars as tp

# Method documentation
?tp.Tibble.summarize

# Function documentation
?tp.mean

Or you can find them for each function here

@gshotwell
Copy link

I have a pretty good workflow for quickly type-annotating Python code, I'd be happy to add it to tidypolars. I think it would be a good thing to do especially if you're planning on doing a big refactor.

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

No branches or pull requests

3 participants