Moar docstrings
ctjacobs opened this issue · 2 comments
ctjacobs commented
Add more docstrings throughout the codebase, and specify :returns:, :param:, etc in rst format. Maybe autogenerate the function docs and add to the PyQSO Read the Docs page?
ctjacobs commented
This is being addressed in the moar-docstrings branch.
ctjacobs commented
Branch merged. Addressed by 45abb28.
The 'apidoc' is now also included in the PyQSO Read the Docs page, but unfortunately only the ADIF class documentation builds properly - the others fail as the builder cannot import Gtk, etc. I will try to take a look at this later.