Examples on how to use simtools can currently be found in at least three places:
- application docstrings
- documentation pages in docs/sources
- integration tests
Quite often 2 out of those 3 places are wrong:
- examples are irrelevant
- configuration is out of date
- test input is out of date
This needs to be improved.
My suggestion is to concentrate on integration tests, as they are continuously executed and therefore tested. We need to find a way how to connect the documentation and the integration tests.
(I've quickly looked also in the pytest doctests, but the integration seem to be too complex for this)
Examples on how to use simtools can currently be found in at least three places:
Quite often 2 out of those 3 places are wrong:
This needs to be improved.
My suggestion is to concentrate on integration tests, as they are continuously executed and therefore tested. We need to find a way how to connect the documentation and the integration tests.
(I've quickly looked also in the pytest doctests, but the integration seem to be too complex for this)