odlgroup / odl

Operator Discretization Library https://odlgroup.github.io/odl/
Mozilla Public License 2.0
374 stars 105 forks source link

Slightly relax coding-style checks #1652

Open leftaroundabout opened 3 months ago

leftaroundabout commented 3 months ago

This topic is up for debate.

It is certainly good to adhere to a style guide and PEP 8 is established and mostly sensible. However, I find myself repeatedly clashing with the pep8speaks linter, particularly its very narrow understanding of where whitespace is and isn't allowed. In some cases I find the "fixed" version (according to these rules) to have significantly worse readability, because they require e.g. breaking lines in inconvenient spots and disallow aligning code in an eye-intuitive way.

This can be avoided by ignoring some of the linter rules. I would suggest reflecting that in the pep8speaks configuration, so it isn't a sticking point in every single pull request.

Particularly debatable is the 80-characters limit. In my opinion it is good to aim for 80 characters, but not to be dogmatic about it and to introduce a line break just to avoid having 3 characters too many in a line (especially when the line break also requires extra parentheses, and more indentation).