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

Added type hints for all functions; Added parameter documentation; Updated GitHub actions to work better with nox and poetry; #13

Merged
merged 2 commits into from
Jan 11, 2021

Conversation

rajivsarvepalli
Copy link
Owner

All functions, classes, and modules are documented completely. Also, ensured types are checked statically and dynamically. Ensure types are appropriately tested to not miss any edge cases such as List[int] instead of Sequence[int]. poetry and nox should interface better now and typeguard has been to run to test typing. However, mypy is not run yet due to lack of stubs for sqlalchemy. I will investigate further to see if mypy is reasonable to run on sqlalchemy and this project.

Fixes #6

@rajivsarvepalli rajivsarvepalli added documentation Improvements or additions to documentation ci Changes to CI configuration files and scripts style Changes that do not affect the meaning of the code (white-space, formatting, etc) labels Jan 11, 2021
@rajivsarvepalli rajivsarvepalli merged commit 1fbbfb0 into master Jan 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Changes to CI configuration files and scripts documentation Improvements or additions to documentation style Changes that do not affect the meaning of the code (white-space, formatting, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Type Hints, and Parameter Documentation
1 participant