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 hints and doc strings #62

Open
aj3sh opened this issue May 31, 2023 · 0 comments
Open

Add type hints and doc strings #62

aj3sh opened this issue May 31, 2023 · 0 comments

Comments

@aj3sh
Copy link
Member

aj3sh commented May 31, 2023

Use Case
This Python package doesn't contain proper type hints and doc strings. A proper type hint and doc string help the end user to use the package. Furthermore, it will also help generate the docs through the codes.

Challenges
As this task involves all the files within the repository. The chances of occurring merge conflicts are high.

Proposed Solution
Partial changes with partial PR will help reduce the merge conflicts. That is to say, only one file will be refactored at once. If anyone is picking to refactor a file, Please comment on this PR.

@aj3sh aj3sh self-assigned this May 31, 2023
@aj3sh aj3sh removed their assignment Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant