m2lines / gz21_ocean_momentum

Stochastic-Deep Learning Parameterization of Ocean Momentum Forcing
MIT License
5 stars 1 forks source link

Resolve pedantic linting CI checks #109

Open raehik opened 9 months ago

raehik commented 9 months ago

We added GitHub CI earlier which checks some PyTests and runs some linting checks. Those linting checks complain a lot e.g. a line for every function missing a docstring, and are failing on main.

Should we enforce a particular style & keep these CI checks? Should we forget about them? Should we just have recommendations without linting CI, and retain instructions for running local checks? (I'm not very opinionated on Python style, so my first choice would be to not to enforce anything.)

Supplants #16 .