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

Code style check #420

Open
amrit110 opened this issue May 8, 2023 · 0 comments
Open

Code style check #420

amrit110 opened this issue May 8, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@amrit110
Copy link
Member

amrit110 commented May 8, 2023

This issue has 2 parts:

  • The codebase needs a review to see if it adheres to google code style guide (https://google.github.io/styleguide/pyguide.html).

  • For docstrings, the parameter types are documented using type hints, and adding them to the docstring is redundant. These can be removed to keep docstrings clean and reduce redundancy.

@amrit110 amrit110 added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant