Code Linting in Continuous Integration

kyleaoman commented 1 month ago

Continuous integration should check that code conforms to a consistent style. Some suggestions:

[x] At a minimum check PEP8 compliance with a tool such as flake8.
[x] Recommend adopting a formatting style such as black and checking in CI. Related: #168
[ ] Consider also checking docstrings. They appear to loosely conform to the numpy style. This can be checked (and the level of compliance configured) with a tool such as numpydoc. At a minimum checking for consistency between arguments in function definitions and in docstring is a good idea.

This issue is part of my PyOpenSci review. For review pass/fail purposes, resolving it is required.

robelgeda commented 3 weeks ago

descoping due to docstrings

robelgeda commented 3 weeks ago

I have added ruff checks to the code but need time and careful attention to fix the other issues. It would either take more time or too quick to be fair to the end user to correct the doc and doc-string issues now. Leaving this ticket open but we should be set for the PYOS review assuming the docstring cleanup can happen after the process.

PetroFit / petrofit

Code Linting in Continuous Integration #214