pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-09 14:24:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update FAQ to be a bit clearer

Browse source
This commit is contained in:
Ian Cordasco 2016-06-21 07:36:40 -05:00
parent a4c1edb03e
commit f3cd7ee6fb
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
1 changed files with 20 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/source/faq.rst
View file

@ -31,14 +31,26 @@ Why does Flake8 use ranges for its dependencies?
================================================ ================================================
|Flake8| uses ranges for mccabe, pyflakes, and pycodestyle because each of |Flake8| uses ranges for mccabe, pyflakes, and pycodestyle because each of
those projects tend to add *new* checks between minor releases. |Flake8| those projects tend to add *new* checks in minor releases. It has been an
does not restrict you from using patch versions, but |Flake8| likes to implicit design goal of |Flake8|'s to make the list of error codes stable in
ensure that if you install |Flake8| 2.6.x repeatedly you will not be its own minor releases. That way if you install something from the 2.5
surprised at a later time by a new error code suddenly breaking your series today, you will not find new checks in the same series in a month
linting. Instead, we use minor versions of |Flake8| to add new checks from from now when you install it again.
dependencies intentionally.
**Please do not file issues to tell the Flake8 team that a new version is |Flake8|'s dependencies tend to avoid new checks in patch versions which is
available on PyPI.** The current Flake8 core team (of one person) is also why |Flake8| expresses its dependencies roughly as::
pycodestyle >= 2.0.0, < 2.1.0
pyflakes >= 0.8.0, != 1.2.0, != 1.2.1, != 1.2.2, < 1.3.0
mccabe >= 0.5.0, < 0.6.0
This allows those projects to release patch versions that fix bugs and for
|Flake8| users to consume those fixes.
Should I file an issue when a new version of a dependency is available?
=======================================================================
**No.** The current Flake8 core team (of one person) is also
a core developer of pycodestyle, pyflakes, and mccabe. They are aware of a core developer of pycodestyle, pyflakes, and mccabe. They are aware of
these releases. these releases.