How to tell flake8 to ignore comments
I've figured out a possible solution to this, but there might be something better. If you write a comment that will raise an E501 error, i.e. it is too long, you can append that line with # noqa: E501
, and flake8 will ignore it. For example:
# This is a really really long comment that would usually be flagged by flake8 because it is longer than 79 characters
would usually raise an E501, but
# This is a really really long comment that would usually be flagged by flake8 because it is longer than 79 characters # noqa: E501
will not.
documented here.
You can change the list of codes ignored by flake8
using a configuration file. For example, in your project directory create a file named .flake8
with the following content:
[flake8]
per-file-ignores =
# line too long
path/to/file.py: E501,
This may be easier than using # noqa
comments.