tidypolars icon indicating copy to clipboard operation
tidypolars copied to clipboard

plans for adding type hints

Open mr-majkel opened this issue 2 years ago • 2 comments

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?

mr-majkel avatar Nov 30 '22 23:11 mr-majkel

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

markfairbanks avatar Dec 05 '22 20:12 markfairbanks

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.

gshotwell avatar May 06 '24 12:05 gshotwell