Start writing new documentation around --select

In order to write this documentation, we need to also add documentation
for the --max-complexity option which was heretofore undocumented.
This commit is contained in:
Ian Cordasco 2017-05-29 20:07:13 -05:00
parent fec980a856
commit d411ced0f6
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
4 changed files with 293 additions and 91 deletions

View file

@ -796,3 +796,24 @@
}
This **can not** be specified in config files.
.. option:: --max-complexity=<n>
Set the maximum allowed McCabe complexity value for a block of code.
This option is provided by the ``mccabe`` dependency's |Flake8| plugin.
Command-line usage:
.. prompt:: bash
flake8 --max-complexity 15 dir/
This **can** be specified in config files.
Example config file usage:
.. code-block:: ini
max-complexity = 15