search

edwardoughton / itmlogic

Longley-Rice Irregular Terrain Model (itmlogic)
https://itmlogic.readthedocs.io/en/latest/?badge=latest
Other
55 stars 21 forks source link

Docstrings for tests #44

Closed garrettj403 closed 4 years ago

garrettj403 commented 4 years ago

It's very difficult to follow what the tests are testing.

For example, in test_lrprop.py, where does setup_expected_prop_to_test_lrprop come from? Were these results generated by the previous FORTRAN/C++/MATLAB code?

It would be helpful to have short docstrings broadly describing each test.

edwardoughton commented 4 years ago

@garrettj403 Doc strings have now been improved throughout all modules and tests. Where we have a direct reference for an equation in the references documentation, we have been explicit about it. Hopefully this makes things a bit clearer now.