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

Docs/numpystyle use #159

Merged
merged 5 commits into from
Aug 18, 2022
Merged

Conversation

luciecastella
Copy link
Contributor

Closes #158

Resolves the numpystyle issue with proper docstrings for the optional parameters.

Copy link
Member

@danielhuppmann danielhuppmann left a 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

nomenclature/testing.py Outdated Show resolved Hide resolved
nomenclature/testing.py Outdated Show resolved Hide resolved
Co-authored-by: Daniel Huppmann <dh@dergelbesalon.at>
Copy link
Member

@danielhuppmann danielhuppmann left a 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!

Copy link
Contributor

@phackstock phackstock left a 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.

@phackstock phackstock merged commit 089602d into IAMconsortium:main Aug 18, 2022
@luciecastella luciecastella deleted the Docs/numpystyle-use branch August 23, 2022 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use numpystyle correctly in docstrings
3 participants