[Documentation] Improvement of docstrings - Githubissues

greco-project / pvcompare

pvcompare is a model for comparing the benefits of different PV technologies in local energy systems in different energy supply scenarios.

GNU Affero General Public License v3.0

13 stars 4 forks source link

[Documentation] Improvement of docstrings #303

Open SabineHaas opened 3 years ago

SabineHaas commented 3 years ago

The docstrings of pvcompare need revisions:

this docstring can serve as example
all parameters mentioned and fully explained?, remove deprecated parameters
short first line statement, other explanations after one empty line
all docstrings should be raw strings: start with r"""
adapt references, example doc and the code

Whenever there's anything unclear or missing please add a "TODO" in the respective line. We will solve them during the reviews.

It would be good to have several PRs for solving this issue. This way reviews will be easier.

PR1:

[x] demand.py --> please also check with demand section in RTD, the information there is up-to-date.

PR2:

[x] main.py
[x] area_potential.py

PR3:

[x] pv_feedin.py
[x] apply_cpvlib_StaticHybridSystem.py in directory cpv

PR4:

[x] heat_pump_and_chiller.py
[x] stratified_thermal_storage.py

PR5:

[x] check_inputs.py

PR6 (@Piranias):

[ ] plots.py @Piranias note that @Stefanie08 has already worked on this module in #309
[ ] analysis.py
[ ] perosi

SabineHaas commented 3 years ago

Thanks @Stefanie08 for taking on this issue!

Concerning the local sphinx build and installation I have realized that his is described in our contributing.md - I have just updated the description in a PR, the result is here. Please take notes in a new issue in case you notice something wrong during installation :)