Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Guide: address common lint errors #10050
Link to issue number:
Summary of the issue:
Several reports of developers having trouble to know how to resolve lint errors.
Specifically misleading is ET128 (flake8-tabs) unexpected number of tabs and spaces at start of expression line. When this error message says "expects x spaces", its likely that it is expecting a code alignment style, rather than hanging indent style. To change this expectation, first ensure that there is a newline after the opening paren/bracket/brace.
Description of how this pull request fixes the issue:
Also raised an issue with the flake8-tabs project: https://gitlab.com/ntninja/flake8-tabs/issues/1
Known issues with pull request:
Change log entry:
leonardder left a comment
I think this documentation will be very helpful. May be also note in the base readme that the linting documentation also contains a how to on dealing with common linting errors that are easy to understand/resolve.
@leonardder I did a bit of a re-write, I think it is much clearer now. I hope you think so too. I think part of the difficulty here is that there are several terms with subtly differences to learn. Hopefully the changes I've made cover this better.