ESCOMP / CAM-SIMA

Community Atmosphere Model - System for Integrated Modeling of the Atmosphere
4 stars 12 forks source link

Latest version of pylint cedes code formatting checks to "black" #87

Open nusbaume opened 3 years ago

nusbaume commented 3 years ago

It looks like the latest version of pylint (2.6), which is used in the open-sync PR Github actions workflow, no longer manages code formatting issues (e.g. bad whitespace), unless it results in an actual python bug (e.g. bad scope indentation). Instead, automatic formatting checks have been passed to the "black" python formatting project:

https://github.com/psf/black

Thus moving forward if we are interested in having automatic format checks then we may need to invest in using black as well as pylint.

nusbaume commented 6 months ago

Along with implementing black, it might also be good to implement a basic spell-checker like codespell:

https://github.com/codespell-project/codespell

to see if we can ease the code review burden.

Also, it should be noted that at least codespell is language-agnostic, and could be applied to all modified source code files (not just python).