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

Add docstrings to plotting functions #476

Merged
merged 2 commits into from Jan 25, 2021

Conversation

danielhuppmann
Copy link
Member

@danielhuppmann danielhuppmann commented Jan 4, 2021

Please confirm that this PR has done the following:

  • Tests Added
  • Documentation Added
  • Name of contributors Added to AUTHORS.rst
  • Description in RELEASE_NOTES.md Added

Description of PR

Per an offline discussion with @byersiiasa, this PR is a first attempt to add docstrings to the new plot.<kind> functions by inheriting them from the plotting library functions.

Any suggestions/comments?

@danielhuppmann danielhuppmann force-pushed the plotting/docs branch 2 times, most recently from 3be7bb3 to 75ea63e Compare January 5, 2021 07:57
@danielhuppmann danielhuppmann self-assigned this Jan 5, 2021
@danielhuppmann danielhuppmann requested review from gidden and removed request for gidden January 5, 2021 08:03
Copy link
Collaborator

@byersiiasa byersiiasa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks clever!

@danielhuppmann
Copy link
Member Author

Thanks @byersiiasa - not sure if what I did actually is smart, but it's probably better than no docstring at all. So I'll merge and be happy if any more experienced Python developer comes up with a smarter approach here in the future...

@danielhuppmann danielhuppmann merged commit c1346b6 into IAMconsortium:master Jan 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants