search

GEUS-Glaciology-and-Climate / pypromice

Process AWS data from L0 (raw logger) through Lx (end user)
https://pypromice.readthedocs.io
GNU General Public License v2.0
12 stars 4 forks source link

[JOSS review] Document tests #135

Closed jroettenbacher closed 1 year ago

jroettenbacher commented 1 year ago

Hi all, as part of the JOSS review process I went through the repository and found some tests. However, those are not documented in the Documentation. I think this could fit in the Developer Guide.

I see this as an enhancement to the usability but not absolutely necessary for acceptance.

Best Johannes

PennyHow commented 1 year ago

Hi @jroettenbacher, are you referring to the unit tests in some of our modules? Like this one:

https://github.com/GEUS-Glaciology-and-Climate/pypromice/blob/95284e639a2843b55397ad891fc3814f7ad84ffd/src/pypromice/process/aws.py#L846-L917

These can be executed from the command line (where pypromice is pip installed into the Python environment) like so:

$  python -m unittest discover pypromice

If this is the case then perhaps some documentation should instead be added to the Developer Install section as these unit tests are good for testing the package install?

jroettenbacher commented 1 year ago

Indeed, these are the ones I meant. I'm not too familiar with testing in python so I didn't know about this command. I agree that adding this to the Developer Install section is a good idea.