-
Notifications
You must be signed in to change notification settings - Fork 1
Add tables to docstrings of plots and test plot functions - #88
Draft
jnnr wants to merge 1 commit into
Draft
Conversation
jnnr
commented
Dec 1, 2022
Collaborator
Author
@monika-o or @Stefanie08, can one of you take over this PR and do the following for each of the function which has been given a table:
- Find out how the DataFrame which the function expects looks like.
- Create a small example in tests/_files/plot_data and name it
input_<name-of-the-function> - Update the link in the docstring of the function to point to the file you created.
It may be that most of the functions expect data of the same form. In that case, do not create a csv for each function, but only one. You can choose a more general name for the csv in that case.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
This adds tables to the docstrings of plot functions which show what data format the plot expects.
The tables are created from csv files that lie in tests/_files/plot_data. This allows us to use the same data to write tests (can happen later or in this PR).
This will help to better understand and maintain the plotting functions collected here. More of oemof-B3s plotting can relocate here and be re-used (and ultimately send to oemof.tabular).