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

Updating the configuration documentation

Browse source 
Signed-off-by: Jason Myers <jason@jasonamyers.com>
This commit is contained in:
Jason Myers 2016-03-28 10:46:26 -05:00
parent 40f1a1e337
commit 4348b61b08
1 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/config.rst
View file

@ -1,12 +1,20 @@
Configuration
=============
The behaviour may be configured at two levels.
Configuration settings are applied in three ways: user, project, and the
``--config`` CLI argument. The user (global) configuration is read first. Next
the project configuration is loaded, and overrides any settings found in both
the user (global) and project configurations. Finally, if the ``--config``
argument is used on the command line, the specified file is loaded and
overrides any settings that overlap with the user (global) and project
configurations.
Global
------
The user settings are read from the ``~/.config/flake8`` file (or the ``~/.flake8`` file on Windows).
User (Global)
-------------
The user settings are read from the ``~/.config/flake8`` file (or the
``~/.flake8`` file on Windows).
Example::
[flake8]