pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-03-30 10:46:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'master' into 'master'

Browse source 
Updating the configuration documentation

Updates the documentation to be clearer on how configuration settings should work.

Related to: !53

See merge request !58
This commit is contained in:
Ian Cordasco 2016-03-28 16:10:37 +00:00
commit ccc01f48d1
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]