summaryrefslogtreecommitdiff
path: root/docs/source/user
Commit message (Collapse)AuthorAgeFilesLines
* Add https://pre-commit.com metadatapre_commit_configAnthony Sottile2018-11-211-0/+49
|
* Grammar fixesVille Skyttä2018-11-112-2/+2
|
* Merge branch 'per-file-style-guide' into 'master'Ian Stapleton Cordasco2018-10-291-0/+40
|\ | | | | | | | | | | | | Add support for per-file ignores in config Closes #156 See merge request pycqa/flake8!259
| * Add versionadded notes for optionsIan Stapleton Cordasco2018-10-271-0/+6
| |
| * Add documentation for --per-file-ignoresIan Stapleton Cordasco2018-10-271-0/+34
| |
* | Clearer docs, NOQA_INLINE_REGEXP comment - fixes #469Jesaja Everling2018-10-281-2/+3
| |
* | Add documentation for `flake8 --extend-ignore`Lars Butler2018-10-261-6/+29
|/ | | | | Also highlight the behavioral differences between `flake --ignore` and `flake --extend-ignore`.
* Fix docs for --isolated flagSargun Vohra2018-09-091-1/+1
|
* Update to pyflakes 2.0.0Miro Hrončok2018-06-051-0/+6
| | | | | | - Add new pyflakes codes - Bump the required versions - Fixes https://gitlab.com/pycqa/flake8/issues/422
* docs: Link fixes and redirect avoidanceVille Skyttä2018-05-211-3/+3
|
* Implement --extend-ignoreVille Skyttä2018-05-162-0/+37
| | | | Refs #365
* Use default comma-separated regex for local-plugin paths.Carl Meyer2017-10-251-1/+1
|
* Add paths option in local-plugins config file.Carl Meyer2017-10-241-0/+21
|
* Document using local pluginsIan Stapleton Cordasco2017-08-121-0/+48
|
* Add way to get back to options indexIan Cordasco2017-05-291-0/+143
|
* Start writing new documentation around --selectIan Cordasco2017-05-294-91/+293
| | | | | In order to write this documentation, we need to also add documentation for the --max-complexity option which was heretofore undocumented.
* Note about error behaviour depending on Python version, e.g. F812Peter Cock2017-04-261-0/+3
|
* Assign missing codes to PyFlakes messagesLukasz Langa2016-11-281-1/+33
| | | | | | | | 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.
* Merge branch 'bug/249' into 'master' Ian Cordasco2016-11-122-0/+70
|\ | | | | | | | | | | | | Add documentation for VCS hooks Closes #249 See merge request !144
| * Add documentation for VCS hooksIan Cordasco2016-11-122-0/+70
| | | | | | | | Closes #249
* | Remove reference to OpenStack SwiftIan Cordasco2016-11-121-5/+2
|/ | | | | | | | | 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
* Add documentation for E999Ian Cordasco2016-10-281-0/+3
|
* Merge branch 'master' into 'master' Ian Cordasco2016-10-252-0/+21
|\ | | | | | | | | | | | | | | | | | | | | 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
| * Fix typo in documentation.Martin Domke2016-08-121-1/+1
| |
| * Add --tee option to split report output stream.Martin Domke2016-07-262-0/+21
| | | | | | | | | | | | | | | | 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).
* | Add --bug-report flag to help bug reportersIan Cordasco2016-08-071-0/+48
| | | | | | | | | | | | | | 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
* | Replace list of violation codesIan Cordasco2016-08-062-0/+50
|/ | | | Closes #206
* Document Legacy APIIan Cordasco2016-07-141-1/+93
|
* Add some notes for users about how to use pluginsIan Cordasco2016-06-252-0/+67
|
* Add missing - to sub-directoriesproposed/3.0Ian Cordasco2016-06-221-1/+1
|
* Use |Flake8| consistently throughout documentationIan Cordasco2016-06-206-50/+50
|
* Add --benchmark option documentationIan Cordasco2016-06-191-0/+21
|
* Grammar and clarity improvements.Cea Stapleton2016-06-194-9/+9
|
* Set a default value for --selectIan Cordasco2016-06-161-1/+1
| | | | | 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.
* Copied one too many lines from templateIan Cordasco2016-06-141-2/+0
|
* Add documentation for --install-hookIan Cordasco2016-06-141-0/+22
|
* Add documentation around specifying a format stringIan Cordasco2016-06-141-2/+16
|
* Add flake8.api and docs for itIan Cordasco2016-06-082-0/+12
| | | | Stub out the primary method people seem to use.
* Add documentation around ignoring errorsIan Cordasco2016-06-073-0/+97
|
* Add --stdin-display-name to modify report outputIan Cordasco2016-06-061-0/+24
|
* Rely on Python 3.4 backport of configparserIan Cordasco2016-05-301-0/+8
| | | | | | 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
* Add template in comments for new optionsIan Cordasco2016-05-291-27/+48
| | | | Also ensure that existing documentation is consistent with the template
* Add a first pass at documenting cli optionsIan Cordasco2016-05-291-65/+604
|
* Start adding descriptions of optionsIan Cordasco2016-05-283-1/+105
|
* Add example configuration sections to the docsIan Cordasco2016-05-281-1/+124
| | | | Add tests to verify our examples do not regress
* Add more to configuration documentationIan Cordasco2016-05-271-0/+49
|
* Begin adding user-facing documentationIan Cordasco2016-05-263-0/+184
| | | | Especially around invocation and configuration
* Add a tiny bit to Usage Guide indexIan Cordasco2016-05-181-0/+14
|
* Add user guide index pageIan Cordasco2016-05-181-0/+4
|
* Move docs directories into docs/sourceIan Cordasco2016-01-251-0/+0