Skip to content

Commit

Permalink
Improve descriptions of our error codes (#450)
Browse files Browse the repository at this point in the history
This PR tries to make the motivation for each flake8-pyi rule clear. As
ruff has reimplemented flake8-pyi's error codes, it's come up a number
of times that it isn't always 100% clear why we're enforcing a
particular rule: some of our error codes enforce things to do with
correctness, but some of them are purely stylistic. (See
astral-sh/ruff#8765 for a recent example.)
I've tried to divide our error codes into four broad categories to
rectify this.

Several of our rules are specifically to do with things working
differently in a stub file compared to at runtime. For some of these
rules, I've also tried to add a few more words to explain exactly how
stubs differ from `.py` files.
  • Loading branch information
AlexWaygood authored Nov 20, 2023
1 parent 70aa7a3 commit 504ef82
Showing 1 changed file with 77 additions and 66 deletions.
Loading

0 comments on commit 504ef82

Please sign in to comment.