search

ucl-exoplanets / ExoTETHyS

GNU General Public License v3.0
17 stars 3 forks source link

Docstrings #9

Closed steven-murray closed 4 years ago

steven-murray commented 4 years ago

Part of JOSS review

It seems that none of the functions in ExoTETHyS have docstrings, which makes it hard to know how to use it, beyond the examples in the README. Some of the functions do have comments which approximate a docstring, and at the very least, these should be converted to docstrings.

gmorello commented 4 years ago

Docstrings completed for sail.py. I will soon start writing the docstrings for trip.py.

steven-murray commented 4 years ago

Those docstrings look good!

gmorello commented 4 years ago

Docstrings are now completed also for trip.py. Can this issue be closed?

steven-murray commented 4 years ago

Yup, great!