mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-08 22:04:17 +00:00
Merge pull request #1413 from nim65s/main
remove user configuration in docs
This commit is contained in:
commit
6f384b8a67
1 changed files with 4 additions and 28 deletions
|
|
@ -24,36 +24,12 @@ Remember that you want to specify certain options without writing
|
||||||
Configuration Locations
|
Configuration Locations
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
|Flake8| supports storing its configuration in the following places:
|
|Flake8| supports storing its configuration in your project in one of
|
||||||
|
``setup.cfg``, ``tox.ini``, or ``.flake8``.
|
||||||
- Your top-level user directory
|
|
||||||
|
|
||||||
- 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
|
Values set at the command line have highest priority, then those in the
|
||||||
project configuration file, then those in your user directory, and finally
|
project configuration file, and finally there are the defaults. However,
|
||||||
there are the defaults. However, there are additional command line options
|
there are additional command line options which can alter this.
|
||||||
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
|
Project Configuration
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue