mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-09 14:24:17 +00:00
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
This commit is contained in:
commit
2ed54042cf
1 changed files with 22 additions and 0 deletions
22
README.rst
22
README.rst
|
|
@ -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.
|
anything that goes beyond 10 is too complex.
|
||||||
See https://en.wikipedia.org/wiki/Cyclomatic_complexity.
|
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
|
Questions or Feedback
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue