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 hinting to the code base and encourage new contributions to include them #497

Closed
Jawfish opened this issue Jul 1, 2022 · 1 comment

Comments

@Jawfish
Copy link
Contributor

Jawfish commented Jul 1, 2022

CircuitPython and KMK's target Python version, 3.6, both support type hinting. I feel this would greatly improve the developer experience and make it easier for new contributors to dive in and familiarize themselves with the codebase.

Some benefits:

  • Most modern code editors that support Python allow quick navigation to type definitions, so contributors can easily see exactly what any given object is and does
  • Catch more errors in the IDE - especially beneficial given this is an embedded systems project
  • IntelliSense and autocomplete for easier familiarization with the codebase and prevention of typos or accessing incorrect/non-existent properties

I volunteer to begin undertaking this if maintainers approve of it.

@Jawfish
Copy link
Contributor Author

Jawfish commented Jul 1, 2022

Nevermind, just saw #205

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

No branches or pull requests

1 participant