-
Notifications
You must be signed in to change notification settings - Fork 14
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
Docs/numpystyle use #159
Docs/numpystyle use #159
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.
Thanks, two suggestions inline
Co-authored-by: Daniel Huppmann <dh@dergelbesalon.at>
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, looks good to me!
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.
Looks good to me as well.
A tip for the future, there is a vs code plugin called autoDocstring, that automatically creates the structure of the docstring for you. I also knows type hints and fills them out. Only thing you have to change is the style which is google by default I think.
Closes #158
Resolves the numpystyle issue with proper docstrings for the optional parameters.