search

NCAR / ADF

A unified collection of python scripts used to generate standard plots from CAM outputs.
Creative Commons Attribution 4.0 International
36 stars 29 forks source link

Diagnostics needs unit and linter (pylint) tests #4

Open nusbaume opened 4 years ago

nusbaume commented 4 years ago

In order to help in the development and maintenance of the CAM diagnostics package, unit tests (either as official python "unittests" or as "doctests") should be developed such that the diagnostics code can be easily tested, including in an automated CI/CD workflow.

Along with this, a method to properly apply the pylint linter program to the CAM diagnostics would also be beneficial, as it would help catch any possible syntax errors, as well as improve readability and portability. Ideally this method can also be automated in a CI/CD workflow, similar to the unit tests.

nusbaume commented 3 years ago

Adding a note here that ideally pylint should be applied to all files in the lib directory, and not jus the adf_xxx.py files. Once that is done this issue will be considered resolved.