[JOSS Review]: Doc strings for some functions/package files missing in Package structure

IPESE / REHO

Decision Support Tool for Renewable Energy Communities

Apache License 2.0

6 stars 11 forks source link

[JOSS Review]: Doc strings for some functions/package files missing in Package structure #26

Closed hgandhi2411 closed 3 months ago

hgandhi2411 commented 4 months ago

Is there an existing issue for this?

[ ] I have searched the existing issues

What happened?

Doc strings for many of the plotting functions appears as "TODO" or is completely missing in the Package Structure page. Corresponding functions are also missing doc strings in the code for these files rainbow_plots.py, sankey.py and plotting.py

Version

1.0.2 (Stable)

Relevant log output

No response

Anything else?

DorsanL commented 3 months ago

The missing DocStrings have been added or completed, and the deprecated plotting functions removed. https://github.com/IPESE/REHO/commit/c14cf7479d126da81a90bafaaa6b0754a5548aa6

Documentation for the plotting functions seems now fine. https://reho.readthedocs.io/en/main/sections/4_Package_structure.html#module-reho.plotting