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

Type hints #2493

Closed
thewchan opened this issue Sep 11, 2021 · 8 comments
Closed

Type hints #2493

thewchan opened this issue Sep 11, 2021 · 8 comments

Comments

@thewchan
Copy link

I know there's a lot of trouble with updating Altair to VL5 especially because of the workload involved, but at the mean time I was wondering if I can help with contributing in more minor ways. I use Altair at work and we do try to enforce pretty strict type safety. Right now much of Altair's API isn't type-annotated. Is this something folks think I can work with without breaking anything? If so I can try to add type hints and make a PR?

@jakevdp
Copy link
Collaborator

jakevdp commented Sep 13, 2021

Thanks - we'd definitely be open to that!

Unfortunately I think there are some stale dependencies in the CI, though, so we may need to address that before doing any significant changes.

@thewchan
Copy link
Author

Thanks for the reply; if that's anything I can help with (although i doubt it?) please let me know.

@thewchan
Copy link
Author

Any updates on this regarding broken dependencies?

@thewchan
Copy link
Author

thewchan commented Jun 7, 2022

@joelostblom @jakevdp Hi again, would still love to help on this, would this be something you all be interested in for future release? I can just add type hints and annotations to all the source files

@joelostblom
Copy link
Contributor

Thanks for offering to help @thewchan ! The major changes to the API for the next version of Altair have already been merged to master, so I believe it would be relatively safe to branch from that and start adding type annotations (note that some files are autogenerated). @jakevdp has the last say on this though and I am not sure which the stale CI dependencies are that he was referring to above (I believe CI is working fine for the more recent PRs so this might have been fixed since his original comment was made).

@thewchan
Copy link
Author

thewchan commented Jun 8, 2022

Great! I'll start on it. Shall I ping you @joelostblom for questions/comments?

@joelostblom
Copy link
Contributor

Feel free to post here if you have questions or put up a draft PR if there are specifics you are wondering about or want to have reviewed. I don't have much ecperience with type hints myself but will try to be helpful where I can.

@binste
Copy link
Contributor

binste commented May 27, 2023

Type hint efforts are now tracked in #2951

@binste binste closed this as completed May 27, 2023
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

4 participants