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

More descriptive documentation about config files.

Browse source
This commit is contained in:
Michal Siska 2021-11-28 19:47:52 +01:00
parent 7a02d04919
commit 0204d636a1
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/source/user/configuration.rst
View file

@ -25,7 +25,8 @@ Configuration Locations
======================= =======================
|Flake8| supports storing its configuration in your project in one of |Flake8| supports storing its configuration in your project in one of
``setup.cfg``, ``tox.ini``, or ``.flake8``. ``setup.cfg``, ``tox.ini``, or ``.flake8``. The configuration is not merged
across those files and files are considered in that particular order.
Values set at the command line have highest priority, then those in the Values set at the command line have highest priority, then those in the
project configuration file, and finally there are the defaults. However, project configuration file, and finally there are the defaults. However,
@ -72,6 +73,15 @@ to be in the ``flake8`` section, which means it needs to start like so:
[flake8] [flake8]
.. note::
If your project does not use ``setup.cfg``, ``tox.ini``, neither
``.flake8``, or they don't contain section ``flake8`` at all, the searching
for suitable configuration file will continue in project's parent
directories. This may lead to parsing no longer supported user-level
configuration at ``~/.flake8``. Please do not rely on this behaviour hence
we are supporting only per-project configuration.
Each command-line option that you want to specify in your config file can Each command-line option that you want to specify in your config file can
be named in either of two ways: be named in either of two ways: