pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-10 23:04:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Replace list of violation codes

Browse source 
Closes #206
This commit is contained in:
Ian Cordasco 2016-08-06 08:28:52 -05:00
parent 690d157d1b
commit b0a99d0b63
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
2 changed files with 50 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

49
docs/source/user/error-codes.rst Normal file
View file

@ -0,0 +1,49 @@
=========================
Error / Violation Codes
=========================
Flake8 and its plugins assign a code to each message that we refer to as a
:term:`error code` (or :term:`violation`). Most plugins will list their error
codes in their documentation or README.
Flake8 installs ``pycodestyle``, ``pyflakes``, and ``mccabe`` by default and
generates its own :term:`error code`\ s for ``pyflakes``:
+------+---------------------------------------------------------------------+
| Code | Example Message |
+======+=====================================================================+
| F401 | ``module`` imported but unused |
+------+---------------------------------------------------------------------+
| F402 | import ``module`` from line ``N`` shadowed by loop variable |
+------+---------------------------------------------------------------------+
| F403 | 'from ``module`` import \*' used; unable to detect undefined names |
+------+---------------------------------------------------------------------+
| F404 | future import(s) ``name`` after other statements |
+------+---------------------------------------------------------------------+
| F405 | ``name`` may be undefined, or defined from star imports: ``module`` |
+------+---------------------------------------------------------------------+
+------+---------------------------------------------------------------------+
| F811 | redefinition of unused ``name`` from line ``N`` |
+------+---------------------------------------------------------------------+
| F812 | list comprehension redefines ``name`` from line ``N`` |
+------+---------------------------------------------------------------------+
| F821 | undefined name ``name`` |
+------+---------------------------------------------------------------------+
| F822 | undefined name ``name`` in __all__ |
+------+---------------------------------------------------------------------+
| F823 | local variable ``name`` ... referenced before assignment |
+------+---------------------------------------------------------------------+
| F831 | duplicate argument ``name`` in function definition |
+------+---------------------------------------------------------------------+
| F841 | local variable ``name`` is assigned to but never used |
+------+---------------------------------------------------------------------+
``mccabe`` only ever reports one :term:`violation` - ``C901`` based on the
complexity value provided by the user.
Users should also reference `pycodestyle's list of error codes`_.
.. links
.. _pycodestyle's list of error codes:
https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes

1
docs/source/user/index.rst
View file

@ -23,6 +23,7 @@ This guide will cover all of these and the nuances for using |Flake8|.
invocation invocation
configuration configuration
options options
error-codes
ignoring-errors ignoring-errors
using-plugins using-plugins
python-api python-api