Commit graph

66 commits

Author SHA1 Message Date
Anthony Sottile
9e41e13627 fix link in configuration docs 2020-08-22 13:09:16 -07:00
Janosh Riebesell
d079132883 add note to configuration.rst that inline comments are not supported 2020-08-21 18:12:19 -07:00
Max Grishkin
f82bceffaf Fixed misprint. 2020-07-28 18:18:58 +00:00
Anthony Sottile
76eeccad89 Support pyflakes 2.2.x 2020-04-11 15:00:52 -07:00
Hugo
9a481c186e Fix typo 2020-03-25 20:29:47 +00:00
Anthony Sottile
6223dd8ab7 Merge branch 'document_before_after' into 'master'
document that contents may appear before/after a noqa comment

Closes #528

See merge request pycqa/flake8!407
2020-01-16 22:58:19 +00:00
Anthony Sottile
b3f54c3f12 document that contents may appear before/after a noqa comment 2020-01-16 14:55:23 -08:00
Sorin Sbarnea
581a8b759b Some typo fixes in git hooks docs 2020-01-16 11:28:43 -08:00
Brian Wignall
591a230940 Fix typos 2019-12-02 15:38:48 +00:00
Eric N. Vander Weele
6017022942 options: Remove parsing --verbose from the configuration file
The `--verbose` option is only used by `flake8`, itself,` when parsing
and handling preliminary options.  After parsing and merging options
from the configuration file, there is no other behavioral impact to the
core of `flake8`.  In other words, setting `verbose = ...` in a
configuration file doesn't change the logging verbosity.

While the `FileProcessor` does expose a `verbose` attribute, obtained
from the parsed options, the verbosity of the core of `flake8` should be
consistent with how a plugin may respond to the attribute's value.
2019-10-12 14:25:50 +01:00
peterjc
9e97143e49 Document priority of configuration files and command line
Closes issue 560.
2019-08-07 10:31:14 +01:00
Markus Gerstel
ce26d89cbf
Fix incorrect error string in documentation
In merge request !300 the description of F631 was accidentally used for
F633.
2019-07-19 23:56:05 +01:00
Thomas Grainger
9ba6677c4a support extend-exclude Fixes #535 2019-07-08 20:12:47 +00:00
Antoine Gallix
e22ed0743e document max-doc-length option 2019-03-20 15:12:14 +01:00
Kevin Locke
d225687c02 options.rst: Update --ignore defaults to match code
3d512ae added W503 and W504 to defaults.IGNORE, but the documentation
was never updated.  This commit updates the docs to match the code.

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
2019-02-16 10:16:12 -07:00
Greg Back
cd55068eac Update documentation with new pyflakes error codes.
- F632 and F633 were missing
- F721 and F722 were combined in the same row
- F723 was missing
2019-01-31 16:01:25 -06:00
Anthony Sottile
ef5ef0d9bf Add https://pre-commit.com metadata 2018-11-21 13:40:48 -08:00
Ville Skyttä
dedb741fad Grammar fixes 2018-11-11 11:14:51 +02:00
Ian Stapleton Cordasco
4439ea2025 Merge branch 'per-file-style-guide' into 'master'
Add support for per-file ignores in config

Closes #156

See merge request pycqa/flake8!259
2018-10-29 15:37:11 +00:00
Jesaja Everling
cafe780514 Clearer docs, NOQA_INLINE_REGEXP comment - fixes #469 2018-10-28 20:17:01 +01:00
Ian Stapleton Cordasco
6ae2295bfe
Add versionadded notes for options 2018-10-27 11:58:51 -05:00
Ian Stapleton Cordasco
19148eb5d7
Add documentation for --per-file-ignores 2018-10-27 11:35:07 -05:00
Lars Butler
144b5af7a8 Add documentation for flake8 --extend-ignore
Also highlight the behavioral differences between `flake --ignore` and
`flake --extend-ignore`.
2018-10-26 17:42:00 +02:00
Sargun Vohra
21531962bf Fix docs for --isolated flag 2018-09-09 19:22:58 -07:00
Miro Hrončok
527af5c214 Update to pyflakes 2.0.0
- Add new pyflakes codes
- Bump the required versions
- Fixes https://gitlab.com/pycqa/flake8/issues/422
2018-06-05 16:17:29 +02:00
Ville Skyttä
cc5558c926 docs: Link fixes and redirect avoidance 2018-05-21 18:17:59 +02:00
Ville Skyttä
e520c2d936 Implement --extend-ignore
Refs #365
2018-05-16 08:50:26 +02:00
Carl Meyer
dd1e9d1cb7 Use default comma-separated regex for local-plugin paths. 2017-10-25 08:57:46 -07:00
Carl Meyer
423980164b Add paths option in local-plugins config file. 2017-10-24 19:58:18 -07:00
Ian Stapleton Cordasco
c2218e4c9f
Document using local plugins 2017-08-12 08:30:30 -05:00
Ian Cordasco
1827b8cc82
Add way to get back to options index 2017-05-29 20:24:30 -05:00
Ian Cordasco
d411ced0f6
Start writing new documentation around --select
In order to write this documentation, we need to also add documentation
for the --max-complexity option which was heretofore undocumented.
2017-05-29 20:23:51 -05:00
Peter Cock
180196f281 Note about error behaviour depending on Python version, e.g. F812 2017-04-26 10:57:33 +00:00
Lukasz Langa
2f1338c342 Assign missing codes to PyFlakes messages
Some PyFlakes messages weren't covered by unique messages, making them
impossible to select/ignore. This is now fixed.

To ensure we don't regress in the future, a test has been added that fails if
there's any uncovered messages.
2016-11-28 10:34:38 -08:00
Ian Cordasco
43e755e2f4 Merge branch 'bug/249' into 'master'
Add documentation for VCS hooks

Closes #249

See merge request !144
2016-11-12 20:52:15 +00:00
Ian Cordasco
f4a5021660
Add documentation for VCS hooks
Closes #249
2016-11-12 14:21:42 -06:00
Ian Cordasco
7d0e950569
Remove reference to OpenStack Swift
This section of the docs could be read as pointing out the project as a
bad example. It was not intended this way, but I would like to avoid
anyone interpreting it this way. As a result, we'll continue to use
their configuration section as an example but not name names.

Closes #228
2016-11-12 14:00:12 -06:00
Ian Cordasco
878bab7ed1
Add documentation for E999 2016-10-28 18:35:56 -05:00
Ian Cordasco
a9e15afbf5 Merge branch 'master' into 'master'
Add --tee option to split report output stream.

The `--tee` option allows the linter report to be written to stdout, even
though it is being redirected to a file with the` --output-file` option.
This is useful if I want to store the report in a separate file for later
analysis but also be able to print the output on screen (e.g when running
in a CI environment).

See merge request !90
2016-10-25 21:34:43 +00:00
Martin Domke
a71941e9fe Fix typo in documentation. 2016-08-12 13:40:58 +02:00
Ian Cordasco
f67f481bee
Add --bug-report flag to help bug reporters
When invoked it will print out JSON that has all of the debugging
information needed by the maintainers to diagnose or reproduce a bug.

Closes #207
2016-08-07 12:31:14 -05:00
Ian Cordasco
b0a99d0b63
Replace list of violation codes
Closes #206
2016-08-06 08:28:52 -05:00
Martin Domke
c782060a06 Add --tee option to split report output stream.
The --tee option allows the linter report to be written to stdout, even
though it is being redirected to a file with the --output-file option.
This is useful if I want to store the report in a separate file for later
analysis but also be able to print the output on screen (e.g when running
in a CI environment).
2016-07-26 15:57:13 +02:00
Ian Cordasco
ec678de427
Document Legacy API 2016-07-14 08:13:10 -05:00
Ian Cordasco
87b331c552
Add some notes for users about how to use plugins 2016-06-25 09:45:08 -05:00
Ian Cordasco
cae943bd44
Add missing - to sub-directories 2016-06-22 19:27:23 -05:00
Ian Cordasco
41277ff965
Use |Flake8| consistently throughout documentation 2016-06-20 08:13:50 -05:00
Ian Cordasco
16f58005bf
Add --benchmark option documentation 2016-06-19 20:41:19 -05:00
Cea Stapleton
330fdb5b56 Grammar and clarity improvements. 2016-06-19 14:06:26 -05:00
Ian Cordasco
1de71fbe89
Set a default value for --select
This allows us to add --append-to-select and --append-to-ignore at a
later date that will work as expected and in a consistent manner.
2016-06-16 08:27:28 -05:00