JOSS: Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?

[andyfaff]

The modules covered in the API documentation (on readthedocs) are satisfactory. However, there are many other functions/objects that are not documented clearly. With Python there is an expectation that objects/functions not prefixed by _ are public. I would presume this JOSS guideline is asking that those public functions be documented clearly. Take, for example, pyrs.core.instrument_geometry.HidraSetup, this class requires a detector_setup parameter for instantiation, but it's not specified what that parameter is (float/int/object/etc).

[fanchercm]

Additional modules were included in the readthedocs to better cover the key functions and classes in the pyrs API