markfairbanks / tidypolars

Tidy interface to polars
http://tidypolars.readthedocs.io
MIT License
321 stars 10 forks source link

plans for adding type hints #220

Open mr-majkel opened 1 year ago

mr-majkel commented 1 year ago

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 commented 1 year ago

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 commented 2 months ago

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.