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

Configure mypy and type annotate the code #35

Closed
ClasherKasten opened this issue Sep 24, 2022 · 4 comments · Fixed by #41
Closed

Configure mypy and type annotate the code #35

ClasherKasten opened this issue Sep 24, 2022 · 4 comments · Fixed by #41
Assignees
Labels
hacktoberfest Label for Hacktoberfest issues

Comments

@ClasherKasten
Copy link
Collaborator

The code is untyped, what doesnn't cause problems, but type code would make it easier for people to work with the code.
(This is an feature what would be kinda cool if we provide something like an API in the future to make it more hackable)

Tasks which have to be done to accomplish this would be:

  • setup mypy
  • add type annotations to almost everything
@ClasherKasten ClasherKasten added the hacktoberfest Label for Hacktoberfest issues label Sep 24, 2022
@aaaandrzej
Copy link
Contributor

Hey, good idea, I'm happy to do to this next week.

@ClasherKasten
Copy link
Collaborator Author

Hi @aaaandrzej,

very cool that you want to work on this. I just want to mention that some parts of the code could be rewritten/deprecated while making the AI faster (as discussed in #32). Right now I'm deepening my knowledge in the topics written down in the issue and try to provide a concrete plan (or even an implementation) as soon as possible.

@aaaandrzej
Copy link
Contributor

OK, understood, and thanks for the heads up. Don't worry if the code changes while I'll be adding mypy related stuff, the codebase isn't big so it shouldn't be an issue to redo anything if needed.

One question on this occasion though, how do you feel about PEP8? I could probably do some renames while working on this issue if you're OK with that. I mean mostly function names to follow snake_case instead of camelCase as described in PEP8.

@ClasherKasten
Copy link
Collaborator Author

I didn't thought about PEP8 in this project much till now.
But I have no problems with you changing some names. Please just reference issue #33 when opening the PR.

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

Successfully merging a pull request may close this issue.

2 participants