From 7d0e9505690aa23cc684a25a7c67ce774673192a Mon Sep 17 00:00:00 2001 From: Ian Cordasco Date: Sat, 12 Nov 2016 14:00:12 -0600 Subject: [PATCH] Remove reference to OpenStack Swift 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 --- docs/source/user/configuration.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/source/user/configuration.rst b/docs/source/user/configuration.rst index 439aeae..5e81807 100644 --- a/docs/source/user/configuration.rst +++ b/docs/source/user/configuration.rst @@ -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