From ac2059d1547f301e840962715850f1d326c6ae1e Mon Sep 17 00:00:00 2001 From: Guilhem Saurel Date: Mon, 11 Oct 2021 20:49:57 +0200 Subject: [PATCH 1/2] update doc after #1404 --- docs/source/user/configuration.rst | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/docs/source/user/configuration.rst b/docs/source/user/configuration.rst index 31a3e1e..67aba82 100644 --- a/docs/source/user/configuration.rst +++ b/docs/source/user/configuration.rst @@ -36,26 +36,6 @@ there are the defaults. However, there are additional command line options which can alter this. -"User" Configuration --------------------- - -|Flake8| allows a user to use "global" configuration file to store preferences. -The user configuration file is expected to be stored somewhere in the user's -"home" directory. - -- On Windows the "home" directory will be something like - ``C:\\Users\sigmavirus24``, a.k.a, ``~\``. - -- On Linux and other Unix like systems (including OS X) we will look in - ``~/``. - -Note that |Flake8| looks for ``~\.flake8`` on Windows and ``~/.config/flake8`` -on Linux and other Unix systems. - -User configuration files use the same syntax as Project Configuration files. -Keep reading to see that syntax. - - Project Configuration --------------------- From d835bc839703b45c4fb2d4e0b951b49c7e3bb962 Mon Sep 17 00:00:00 2001 From: Guilhem Saurel Date: Mon, 11 Oct 2021 20:54:47 +0200 Subject: [PATCH 2/2] remove more mentions of user-level configuration in docs --- docs/source/user/configuration.rst | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/source/user/configuration.rst b/docs/source/user/configuration.rst index 67aba82..f26674b 100644 --- a/docs/source/user/configuration.rst +++ b/docs/source/user/configuration.rst @@ -24,16 +24,12 @@ Remember that you want to specify certain options without writing Configuration Locations ======================= -|Flake8| supports storing its configuration in the following places: - -- Your top-level user directory - -- In your project in one of ``setup.cfg``, ``tox.ini``, or ``.flake8``. +|Flake8| supports storing its configuration in your project in one of +``setup.cfg``, ``tox.ini``, or ``.flake8``. Values set at the command line have highest priority, then those in the -project configuration file, then those in your user directory, and finally -there are the defaults. However, there are additional command line options -which can alter this. +project configuration file, and finally there are the defaults. However, +there are additional command line options which can alter this. Project Configuration