rl-institut / multi-vector-simulator

Multi-vector Simulation Tool assessing and optimizing Local Energy Systems (LES) for the E-LAND project
GNU General Public License v2.0
21 stars 10 forks source link

Docstrings for modules are missing #81

Open smartie2076 opened 4 years ago

smartie2076 commented 4 years ago

We have to write docstrings for our modules, so that readthedocs can help users or new programmers.

To keep track of the modules that need docstrings:

smartie2076 commented 4 years ago

@Bachibouzouk, @SabineHaas, @ursulaelmir please keep in mind to update the list if a module is completely commented out with docstrings.

SabineHaas commented 4 years ago

I started to write docstrings when writing the test function names. Started for C1 in #152. I think this makes sense as I need to understand the functionality for testing - so I can also add a docstring :)

SabineHaas commented 4 years ago

I checked the boxes of the modules that do have docstrings already. And wrote some todos behind the boxes I didn't check. Feel free to add your names to the modules you write docstrings for and check the boxes once you're done :)

smartie2076 commented 3 years ago

We should check the progress on this task.