albertjlguo / sfcNordic

Leeds bachelor final project: Centralized control algorithms for Nordic Smart Grid operation (Python x MATLAB).
GNU General Public License v3.0
3 stars 1 forks source link

Documentation convention #2

Open apetros opened 5 years ago

apetros commented 5 years ago

The documentation convention used for the functions is very strange and doesn’t give enough information.

Please follow the proper convention as shown here: https://www.datacamp.com/community/tutorials/docstrings-python

I use the Sphinx convention but it’s up to you.