diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2015-12-11 14:17:53 +0000 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2015-12-11 14:17:53 +0000 |
| commit | 2ed54042cf42cc44ec38a16ab932ca6cd75c4e06 (patch) | |
| tree | 162ba469a4a41135d861f18782b0d3001e14166a | |
| parent | acea4affaab26274bc3f6d8ec1983cf3af6f1b57 (diff) | |
| parent | 17e397fb2c3b5ae0b3ff654beaf6648de1b87b85 (diff) | |
| download | flake8-2ed54042cf42cc44ec38a16ab932ca6cd75c4e06.tar.gz | |
Merge branch 'master' into 'master'
Add a FAQ section to the readme
It seems like these two questions happen a lot, and are a source of strife. I know that many people won't read an FAQ, but at the very least, it will be a place to point people instead of, "Google for information."
See merge request !46
| -rw-r--r-- | README.rst | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -57,6 +57,28 @@ This feature is quite useful to detect over-complex code. According to McCabe, anything that goes beyond 10 is too complex. See https://en.wikipedia.org/wiki/Cyclomatic_complexity. + +Frequently Asked Questions +========================== + +Why does flake8 pin the version of pep8? +---------------------------------------- + +Version 1.6 of pep8 doesn't work properly with flake8. Until pep8 releases a +version that works, flake8 pins the version of pep8 so that flake8 will work as +a whole. + +Is flake8 broken? +----------------- + +Flake8 combines two other projects that are significant on their own: pep8 and +PyFlakes. If flake8 is doing something you don't like, it is quite likely that +the problem lies in one of those other projects. You can run them separately +to see if they are the cause of your difficulties. We greatly appreciate your +efforts to diagnose the source of the problem before reporting bugs against +flake8. + + Questions or Feedback ===================== |