diff --git a/docs/source/user/options.rst b/docs/source/user/options.rst index d2c0edb..46aff18 100644 --- a/docs/source/user/options.rst +++ b/docs/source/user/options.rst @@ -482,6 +482,7 @@ Options and their Descriptions W234 extend-ignore = E4,E51,W234 +.. _per-file-ignores: .. option:: --per-file-ignores=[ ] diff --git a/docs/source/user/violations.rst b/docs/source/user/violations.rst index e7591e7..b061998 100644 --- a/docs/source/user/violations.rst +++ b/docs/source/user/violations.rst @@ -120,8 +120,11 @@ Ignoring Entire Files Imagine a situation where we are adding |Flake8| to a codebase. Let's further imagine that with the exception of a few particularly bad files, we can add -|Flake8| easily and move on with our lives. There are two ways to ignore the -file: +|Flake8| easily and move on with our lives. There are several ways to ignore +the file or only rules: + +#. Add file patterns and rules to ignore via + :ref:`per-file-ignores ` option #. By explicitly adding it to our list of excluded paths (see: :option:`flake8 --exclude`)