DOC: Cleanup docstrings

NREL / bifacialvf

Bifacial PV View Factor model for system performance calculation

https://bifacialvf.readthedocs.io

Other

29 stars 18 forks source link

DOC: Cleanup docstrings #13

Closed mikofski closed 5 years ago

mikofski commented 5 years ago

[x] use NumpyDoc format for docstrings throughout
[x] add sphinx, create api.rst for files
[x] fix imports
[x] wrap long lines and other pep8 where necessary
[x] any compatibility issues

mikofski commented 5 years ago

Hi @shirubana and @cdeline , I think this is ready to merge.

only focuses on the docstrings in bifacialvf/vf.py. In addition it also adds Sphinx documentation which you can build in the docs folder by running:

bifacialvf/docs$ make html

I will open separate PR’s for the other files, and separate PR’s to bring bifacialvf into conformance with pep8, pycodestyle, pylint, and other python standards. Again, doing it all in one go would be difficult IMO.

cdeline commented 5 years ago

Excellent, this vastly improved my pylint from -25.47/10 to -12.3/10. Hopefully you had the help of autoPEP8 or something like that - manually doing line breaks is not much fun.

cdeline commented 5 years ago

I wasn't familiar with Sphinx docs, but it looks pretty good when I compiled it. Thanks!