-
-
Notifications
You must be signed in to change notification settings - Fork 85
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
Improve code comments #31
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code looks good for me! I left one small comment on a docstring, but once it's fixed, we can merge this. Do you think we should add black to the project as well?
I still want to double check this before getting it merged, @berinhard. Thanks for your comments! |
412bba8
to
95d13e4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for being careful with the code comments @anapaulagomes! About Black, I've created issue #38 to address that.
This PR is an attempt of making the comments stick to a style. We're considering to adopt Google's docstrings but open to suggestions as usual.
pydocstyle
as pre-commit hookpydocstyle
complains, except for the ones that would demand to add new comments: