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

Start adding descriptions of options

Browse source
This commit is contained in:
Ian Cordasco 2016-05-28 12:20:46 -05:00
parent 466ef2e596
commit 89c9ec795e
3 changed files with 105 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/source/user/configuration.rst
View file

@ -45,6 +45,9 @@ The user configuration file is expected to be stored somewhere in the user's
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
---------------------
@ -93,7 +96,13 @@ be named in either of two ways:
#. Simply using hyphens (without the leading hyphens)
So let's actually look at Flake8's own configuration section:
.. note::
Not every Flake8 command-line option can be specified in the configuration
file. See :ref:`our list of options <options-list>` to determine which
options will be parsed from the configuration files.
Let's actually look at Flake8's own configuration section:
.. code-block:: ini
@ -146,6 +155,10 @@ This would allow us to add comments for why we're excluding items, e.g.,
dist
max-complexity = 10
.. note::
You can also specify ``--max-complexity`` as ``max_complexity = 10``.
This is also useful if you have a long list of error codes to ignore. Let's
look at a portion of OpenStack's Swift project configuration: