From aa51e6662bdbcfbe164e671e7a8e782f68701832 Mon Sep 17 00:00:00 2001 From: Paciupa <65620103+Paciupa@users.noreply.github.com> Date: Wed, 7 Feb 2024 17:51:46 +0300 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Ian Stapleton Cordasco --- docs/source/user/violations.rst | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/source/user/violations.rst b/docs/source/user/violations.rst index 97ef88f..7e0075f 100644 --- a/docs/source/user/violations.rst +++ b/docs/source/user/violations.rst @@ -136,25 +136,31 @@ the errors in that file will show up without having to modify our configuration. Both exist so we can choose which is better for us. -Ignoring Violations for some Files ------------------------ +Ignoring Violations in Specific Files +------------------------------------- -Sometimes, we might want to ignore some error codes (or class of error codes) for -some part of our project (tests for example). -We can do this using :option:`flake8 --per-file-ignores` from CLI: +If we want to ignore one or more violation codes for certain files, you can +use the :option:`flake8 --per-file-ignores` on either the command-line +or in your configuration file. .. prompt:: bash - flake8 --per-file-ignores='project/test.py:F841 setup.py:E121' - flake8 --per-file-ignores='tests/*:F841 setup.py:E121' + flake8 --per-file-ignores='project/test.py:F841 setup.py:E121' + flake8 --per-file-ignores='tests/*:F841,D setup.py:E121' +.. note:: + + While most options in Flake8 use commas to separate values, this option allows + multiple violation codes to be specified per file with commas so to specify + multiple file mappings use spaces to delimit them. + We can also specify it in config file: .. code-block:: ini per-file-ignores = project/test.py:F841 - tests/*:F841 + tests/*:F841,D setup.py:E121 other_project/*:W9