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.

Sign up for GitHub

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

Jump to bottom

Let's use type hints! #1

Open
1 of 3 tasks
tailaiw opened this issue Sep 27, 2019 · 2 comments
Open
1 of 3 tasks

Let's use type hints! #1

tailaiw opened this issue Sep 27, 2019 · 2 comments
Assignees
@roycoding
Labels
help wanted Extra attention is needed

Comments

@tailaiw
Copy link
Contributor

tailaiw commented Sep 27, 2019 •
edited by roycoding

We like to start using type hints for better practice of python programming. For a first-time contributor, this is probably a nice starting point, as you will go through every part of the code base and familiarize yourself with the code structure.

To-do's:

  • Add type hints to all functions.
  • Modify docstrings accordingly, so sphinx-autodoc will automatically grab type info from type hints.
  • Add unit tests (with mypy?) for type checking.

Have fun!
@tailaiw tailaiw added the help wanted Extra attention is needed label Sep 27, 2019
@roycoding roycoding self-assigned this Nov 24, 2019
@roycoding roycoding mentioned this issue Dec 28, 2019
Closed
@roycoding
Copy link
Contributor

WIP in branch type-hints

@roycoding roycoding mentioned this issue Jan 14, 2020
Merged
@Holt59 Holt59 mentioned this issue Apr 21, 2021
Open
@Pask423
Copy link

Pask423 commented Jul 8, 2022 •
edited

Hi,
Is this issue still valid and open, as I would like to try implement it ?
Same for #15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@roycoding roycoding

Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@roycoding @tailaiw @Pask423