search

ctjacobs / pyqso

PyQSO is a contact logging tool for amateur radio operators.
http://christianjacobs.uk/pyqso
GNU General Public License v3.0
77 stars 19 forks source link

Moar docstrings #33

Closed ctjacobs closed 9 years ago

ctjacobs commented 9 years ago

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 9 years ago

This is being addressed in the moar-docstrings branch.

ctjacobs commented 9 years ago

Branch merged. Addressed by 45abb28e3873c8dbd68a4376090cd821033581b8.

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.