Skip to content

Add type hinting #36

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

Open
venaturum opened this issue Oct 14, 2020 · 2 comments · Fixed by #154
Open

Add type hinting #36

venaturum opened this issue Oct 14, 2020 · 2 comments · Fixed by #154
Labels
code quality improvements to code quality high priority

Comments

@venaturum
Copy link
Collaborator

venaturum commented Oct 14, 2020

There are currently no type-hints in staircase.

Background/resources:
https://docs.python.org/3/library/typing.html
https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html
https://realpython.com/lessons/type-hinting/

https://github.com/staircase-dev/staircase/blob/master/staircase/_typing.py has been created for custom types (see https://github.com/pandas-dev/pandas/blob/master/pandas/_typing.py for inspiration)

Please add new issue for each individual file with typing added, and commit separately.

@venaturum venaturum added the documentation Improvements or additions to documentation label Oct 14, 2020
@venaturum venaturum added this to the v2.0.0 milestone Feb 22, 2021
@venaturum venaturum added beginner difficulty level code quality improvements to code quality high priority and removed documentation Improvements or additions to documentation labels Sep 11, 2021
@PabloRuizCuevas PabloRuizCuevas mentioned this issue Oct 10, 2022
4 tasks
@venaturum venaturum removed the beginner difficulty level label Oct 15, 2022
@venaturum venaturum removed this from the v2.0.0 milestone Oct 15, 2022
@PabloRuizCuevas
Copy link
Contributor

Hi! I wouldn't definitely close this issue, as there are some type hints I wasn't able to figure out, or maybe let this close but we could do a new issue for mypy compliance. Whatever you think is best :)

@venaturum venaturum reopened this Oct 25, 2022
@venaturum
Copy link
Collaborator Author

@PabloRuizCuevas no worries

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

Successfully merging a pull request may close this issue.

2 participants