alan-turing-institute / Palaeoanalytics

Repository for the Paleoanalytics project.
https://www.turing.ac.uk/research/research-projects/palaeoanalytics
GNU General Public License v3.0
17 stars 1 forks source link

Incomplete test coverage #168

Closed MichaelHoltonPrice closed 1 year ago

MichaelHoltonPrice commented 2 years ago

First off, my heartiest commendation on a remarkable piece of work. It is at the >99% level in code framework and maturity compared to the many archaeological code bases I interact with, including in its use of tests. I believe your tests are easily sufficient to demonstrate that the code is working as it should, and I will be marking the corresponding item in review to indicate so momentarily.

Nevertheless, it seems worth documenting that the test coverage is not quite complete. In particular (and if I have not made any mistakes), there are no tests for template_matching, data_output, associate_arrows_to_scar, or any of the methods in plotting.py.

JasonGellis commented 2 years ago

@MichaelHoltonPrice Test coverage documentation has been completed. I think there might me some confusion on this. We use the the pytest library. All that's needed is to go to the main Palaeoanalytics directory and type pytest -s

I have added a testing section section - Functional testing of PyLithics - in the REAME.md THis has been merged to the main branch.