mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-03 11:56:52 +00:00
Updated documentation references to pep8 (now pycodestyle)
This commit is contained in:
parent
1db863e60a
commit
25503452b0
3 changed files with 8 additions and 8 deletions
|
|
@ -42,8 +42,8 @@ Settings
|
|||
--------
|
||||
|
||||
This is a (likely incomplete) list of settings that can be used in your config
|
||||
file. In general, any settings that pep8 supports we also support and we add
|
||||
the ability to set ``max-complexity`` as well.
|
||||
file. In general, any settings that ``pycodestyle`` supports we also support and
|
||||
we add the ability to set ``max-complexity`` as well.
|
||||
|
||||
- ``exclude``: comma-separated filename and glob patterns
|
||||
default: ``.svn,CVS,.bzr,.hg,.git,__pycache__``
|
||||
|
|
|
|||
|
|
@ -18,9 +18,9 @@ Documentation
|
|||
Original Projects
|
||||
=================
|
||||
|
||||
Flake8 is just a glue project, all the merits go to the creators of the original
|
||||
projects:
|
||||
Flake8 is just a glue project, all the merits go to the creators and maintainers
|
||||
of the original projects:
|
||||
|
||||
- pep8: https://github.com/jcrocholl/pep8
|
||||
- pycodestyle: https://github.com/pycqa/pycodestyle
|
||||
- PyFlakes: https://launchpad.net/pyflakes
|
||||
- McCabe: http://nedbatchelder.com/blog/200803/python_code_complexity_microtool.html
|
||||
|
|
|
|||
|
|
@ -4,15 +4,15 @@ Warning / Error codes
|
|||
=====================
|
||||
|
||||
The convention of Flake8 is to assign a code to each error or warning, like
|
||||
the ``pep8`` tool. These codes are used to configure the list of errors
|
||||
the ``pycodestyle`` tool. These codes are used to configure the list of errors
|
||||
which are selected or ignored.
|
||||
|
||||
Each code consists of an upper case ASCII letter followed by three digits.
|
||||
The recommendation is to use a different prefix for each plugin. A list of the
|
||||
known prefixes is published below:
|
||||
|
||||
- ``E***``/``W***``: `pep8 errors and warnings
|
||||
<http://pep8.readthedocs.org/en/latest/intro.html#error-codes>`_
|
||||
- ``E***``/``W***``: `pycodestyle errors and warnings
|
||||
<https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes>`_
|
||||
- ``F***``: PyFlakes codes (see below)
|
||||
- ``C9**``: McCabe complexity plugin `mccabe
|
||||
<https://github.com/flintwork/mccabe>`_
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue