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

Add docs

Browse source
This commit is contained in:
Ian Cordasco 2013-02-22 23:18:15 -05:00
parent 50e3ce9c78
commit 257eae684e
12 changed files with 691 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/config.rst Normal file
View file

@ -0,0 +1,28 @@
Configuration
=============
The behaviour may be configured at two levels.
Global
------
The user settings are read from the ``~/.config/flake8`` file.
Example::
[flake8]
ignore = E226,E302,E41
max-line-length = 160
Per-Project
-----------
At the project level, a ``tox.ini`` file or a ``setup.cfg`` file is read
if present. Only the first file is considered. If this file does not
have a ``[flake8]`` section, no project specific configuration is loaded.
Default
-------
If the ``ignore`` option is not in the configuration and not in the arguments,
only the error codes ``E226`` and ``E241/E242`` are ignored
(see codes in the table below).