From 4348b61b0884446c28d76a1629c9cdd08afbd20a Mon Sep 17 00:00:00 2001 From: Jason Myers Date: Mon, 28 Mar 2016 10:46:26 -0500 Subject: [PATCH] Updating the configuration documentation Signed-off-by: Jason Myers --- docs/config.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index 59ba3ec..e429634 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -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]