Slightly relax coding-style checks #1652
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some of the "errors" that pep8speaks / pycodestyle keeps complaining about are merely about whitespace used in a way that does not conform to its simplistic rules. Sometimes, such whitespace can make the code more eye-friendly, and indeed PEP8 explicitly mentions that this is legitimate.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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).