Commit graph

49 commits

Author SHA1 Message Date
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
Ian Cordasco
e2ef07fe80
Copied one too many lines from template 2016-06-14 20:47:35 -05:00
Ian Cordasco
8bb3048775
Add documentation for --install-hook 2016-06-14 20:43:00 -05:00
Ian Cordasco
8a18cfa4a3
Add documentation around specifying a format string 2016-06-14 20:10:09 -05:00
Ian Cordasco
107f595d13
Add flake8.api and docs for it
Stub out the primary method people seem to use.
2016-06-08 11:48:36 -05:00
Ian Cordasco
27dbd61f12
Add documentation around ignoring errors 2016-06-07 18:46:24 -05:00
Ian Cordasco
02bcbee245
Add --stdin-display-name to modify report output 2016-06-06 19:46:29 -05:00
Ian Cordasco
33f982b446 Rely on Python 3.4 backport of configparser
Python 2.7's ConfigParser module does not allow for the behaviour we
have documented for config files in Flake8 3.0. To compensate for that,
we add a dependency on the configparser backport on PyPI for Python 2.7
2016-05-30 12:51:31 -05:00
Ian Cordasco
e9ddf7533b Add template in comments for new options
Also ensure that existing documentation is consistent with the template
2016-05-29 21:04:03 -05:00
Ian Cordasco
4c3d176f9a Add a first pass at documenting cli options 2016-05-29 20:56:30 -05:00
Ian Cordasco
89c9ec795e Start adding descriptions of options 2016-05-28 12:20:46 -05:00
Ian Cordasco
466ef2e596 Add example configuration sections to the docs
Add tests to verify our examples do not regress
2016-05-28 12:00:47 -05:00
Ian Cordasco
50d74e3cce Add more to configuration documentation 2016-05-27 11:03:36 -05:00
Ian Cordasco
a7898e0389 Begin adding user-facing documentation
Especially around invocation and configuration
2016-05-26 13:21:25 -05:00
Ian Cordasco
f353a5db90 Add a tiny bit to Usage Guide index 2016-05-18 23:05:09 -05:00
Ian Cordasco
28a97a8499 Add user guide index page 2016-05-18 22:28:44 -05:00
Ian Cordasco
6590fab3f2 Move docs directories into docs/source 2016-01-25 21:15:04 -06:00