markstory/lint-review

flake8 exclude doesn't work as expected for directories

shoyer opened this issue · 5 comments

With flake8 alone, if I try to exclude my documentation directory as follows, it works:

flake8 --exclude=doc/ .

However, Stickler-CI includes each file explicitly in the command line invocation, e.g.,

flake8 --exclude=doc/ doc/examples/_code/weather_data_setup.py

With this version, the explicitly listed file is no longer included. Instead, I spent a while being frustrated (thinking I was misusing flake8) and eventually found Stickler's files.ignore option.

It might be worth noting this in the docs somewhere. There appears to already be a bug report upstream for flake8: https://gitlab.com/pycqa/flake8/issues/392

I'm not clear on what changes you're wanting to see made to the documentation? Is it that the exclude option doesn't work on directories?

Is it that the exclude option doesn't work on directories?

Yes, that's right. You need to specify filenames, e.g., weather_data_setup.py (or use ignore.files).

Ok. I can do that.

Docs are updated in both this project and on stickler-ci.com.

Thanks!