opensource-nepal / py-nepali

py-nepali is a python package containing features that will be useful for Nepali projects.
MIT License
22 stars 13 forks source link

Add type hints and doc strings #62

Open aj3sh opened 1 year ago

aj3sh commented 1 year ago

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.