Tutorial 02 #259
Tutorial 02 #259
Conversation
-adjust index for documentation -reformulate docstrings in World to google format
-forecaster -scenario loader -units operator -market objects -utils -outputs
-added named variable calling for all MarketConfig calls -removed unused variables from storage
-edited docstring formatting
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #259 +/- ##
==========================================
+ Coverage 78.45% 78.49% +0.04%
==========================================
Files 39 39
Lines 4260 4260
==========================================
+ Hits 3342 3344 +2
+ Misses 918 916 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| trained_actors_path="", | ||
| ) | ||
|
|
||
| Notes: |
There was a problem hiding this comment.
Ah okay so the extra information is now always marked as note in this section and then below?
There was a problem hiding this comment.
yes, the idea is to have a description but extra contents go here
There was a problem hiding this comment.
Yeah I was just wondering about the label "notes". But then we do it this way.
There was a problem hiding this comment.
I documented that as well
| forecaster: Optional[Forecaster] = None, | ||
| manager_address: Optional[Any] = None, |
There was a problem hiding this comment.
Nice that you included the type hint! Can you document that in a todo so that the others will do that as well?
There was a problem hiding this comment.
Love the way it is sturcterd of wirting the csv files by oneself basically, very straight forward :)
- Change the first header to the name of the file as well? Than it would be consitent.
- rename file name to have tutorial instead of examepl? Similar to folder?
- In "Creating Input files" we should link an overview of what units are currently implemented to now which ones can be used. Or what do you think?
- similarly the list of attributes below? Should we not just link it to avoid double book keeping? But maybe that is just not possible.
Co-authored-by: Kim K. Miskiw <[email protected]>
Co-authored-by: Kim K. Miskiw <[email protected]>
|
It does not look good at all. |
|
This is how it should look like: This is how the GPT-docs style shows up: We can merge this as usual and fix it afterwards. |
This commit adds the new example.
It also edits multiple docstring transitioning to the google style docstings. The whole common folder has been edited.
Tests have been also slightly modified, purely cosmetical changes where all marketconfigs have now parameter_name=parameter for easier reading.