Jashcraf / katsu

Polarimetric Data Reduction and machine control for measuring the polarization of observatories
https://katsu.readthedocs.io
MIT License
3 stars 0 forks source link

No instructions on how to run automated tests in documentation #34

Open arendMoerman opened 3 weeks ago

arendMoerman commented 3 weeks ago

This issue is part of my JOSS review: https://github.com/openjournals/joss-reviews/issues/7375

As is described in the reviewer guidelines, the documentation should contain the following:

Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?

To the best of my knowledge, there are no instructions or steps that describe how the tests can be run. I do see that tests have been written and are present in the repository, but the documentation still needs to explicitly state how someone would run these tests.