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

Consolidate docstrings and add type annotations #10

Open
dalonsoa opened this issue Oct 17, 2022 · 0 comments
Open

Consolidate docstrings and add type annotations #10

dalonsoa opened this issue Oct 17, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dalonsoa
Copy link
Contributor

Docstrings should follow the Google style... and have some content. While this might be difficult in some cases, requiring domain knowledge, a minimal description based on what the code is doing in the simple cases will be a time saver.

As a bonus, adding type annotations in those cases when they are clear will also be useful to clarify the meaning of the code.

@dalonsoa dalonsoa added the documentation Improvements or additions to documentation label Oct 17, 2022
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
Projects
None yet
Development

No branches or pull requests

1 participant