pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-03-31 03:06:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove reference to OpenStack Swift

Browse source 
This section of the docs could be read as pointing out the project as a
bad example. It was not intended this way, but I would like to avoid
anyone interpreting it this way. As a result, we'll continue to use
their configuration section as an example but not name names.

Closes #228
This commit is contained in:
Ian Cordasco 2016-11-12 14:00:12 -06:00
parent 6118ceab7f
commit 7d0e950569
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
1 changed files with 2 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -170,7 +170,7 @@ This would allow us to add comments for why we're excluding items, e.g.,
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`_:
look at a portion of a project's Flake8 configuration in their ``tox.ini``:
.. code-block:: ini
@ -220,8 +220,5 @@ They use the comments to describe the check but they could also write this as:
H501
Or they could use each comment to describe **why** they've ignored the check.
|Flake8| knows how to parse these lists and will appropriatey handle
|Flake8| knows how to parse these lists and will appropriately handle
these situations.
.. _project configuration:
https://github.com/openstack/swift/blob/3944d820387f08372c1a29444f4af7d8e6090ae9/tox.ini#L66..L81