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

Updated documentation references to pep8 (now pycodestyle)

Browse source
This commit is contained in:
Ian Lee 2016-05-31 11:08:25 -07:00
parent 1db863e60a
commit 25503452b0
3 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/config.rst
View file

@ -42,8 +42,8 @@ Settings
-------- --------
This is a (likely incomplete) list of settings that can be used in your config 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 file. In general, any settings that ``pycodestyle`` supports we also support and
the ability to set ``max-complexity`` as well. we add the ability to set ``max-complexity`` as well.
- ``exclude``: comma-separated filename and glob patterns - ``exclude``: comma-separated filename and glob patterns
default: ``.svn,CVS,.bzr,.hg,.git,__pycache__`` default: ``.svn,CVS,.bzr,.hg,.git,__pycache__``

6
docs/index.rst
View file

@ -18,9 +18,9 @@ Documentation
Original Projects Original Projects
================= =================
Flake8 is just a glue project, all the merits go to the creators of the original Flake8 is just a glue project, all the merits go to the creators and maintainers
projects: of the original projects:
- pep8: https://github.com/jcrocholl/pep8 - pycodestyle: https://github.com/pycqa/pycodestyle
- PyFlakes: https://launchpad.net/pyflakes - PyFlakes: https://launchpad.net/pyflakes
- McCabe: http://nedbatchelder.com/blog/200803/python_code_complexity_microtool.html - McCabe: http://nedbatchelder.com/blog/200803/python_code_complexity_microtool.html

6
docs/warnings.rst
View file

@ -4,15 +4,15 @@ Warning / Error codes
===================== =====================
The convention of Flake8 is to assign a code to each error or warning, like 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. which are selected or ignored.
Each code consists of an upper case ASCII letter followed by three digits. 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 The recommendation is to use a different prefix for each plugin. A list of the
known prefixes is published below: known prefixes is published below:
- ``E***``/``W***``: `pep8 errors and warnings - ``E***``/``W***``: `pycodestyle errors and warnings
<http://pep8.readthedocs.org/en/latest/intro.html#error-codes>`_ <https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes>`_
- ``F***``: PyFlakes codes (see below) - ``F***``: PyFlakes codes (see below)
- ``C9**``: McCabe complexity plugin `mccabe - ``C9**``: McCabe complexity plugin `mccabe
<https://github.com/flintwork/mccabe>`_ <https://github.com/flintwork/mccabe>`_