summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* Prepare to release 3.1.0 on 2016-11-143.1.0b1Ian Cordasco2016-11-121-1/+1
|
* 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 a missing release not referenceIan Cordasco2016-11-121-1/+7
|
* Exit non-zero if something goes wrong during a runIan Cordasco2016-11-121-1/+10
| | | | | | | | If we handle an exception, or early exit, or really anything, we should exit non-zero (and we used to). This was a minor oversight. Closes #209 Closes #248
* Add release notes for the last several bugsIan Cordasco2016-11-121-0/+61
|
* Add a release note to 3.0.0 about --excludeIan Cordasco2016-11-101-0/+14
| | | | | | | | | When we rewrote Flake8 for 3.0, we unintentionally stopped forcibly excluding some patterns regardless of what the user specified. This note is added after the fact to make it easier for users to determine the cause of any backwards incompatibility they might notice. Closes #250
* Add previous_unindented_logical_line attributeYen Chi Hsuan2016-11-081-0/+1
| | | | | | | | This attribute is introduced in pycodestyle 2.1.0 Closes #246 See: https://github.com/PyCQA/pycodestyle/issues/400
* 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).
* | Trim trailing spaces from documentationIan Cordasco2016-10-251-5/+5
| |
* | Merge branch 'file-tokens' of xzise/flake8Ian Cordasco2016-10-251-11/+11
|\ \
| * | Add support for tokens of a complete fileFabian Neundorf2016-07-221-4/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The `tokens` property of the `FileProcessor` class only contains tokens of the current line but not all tokens. So if a plugin which is only executed once per file, that property is useless. To make the tokens also available to plugins it is now be able to supply all the tokens of a file. It also updates the documentation to separate which parameters are static and which are changed on each line. Using the latter parameters on plugins which are only run once per file isn't very sensible.
* | | Spelling fixesVille Skyttä2016-08-133-3/+3
| | |
* | | Add --bug-report flag to help bug reportersIan Cordasco2016-08-073-0/+53
| | | | | | | | | | | | | | | | | | | | | 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
* | | Add release note about handling SyntaxErrorsIan Cordasco2016-08-061-0/+5
| | |
* | | Set version to 3.0.4 and start release notesIan Cordasco2016-08-052-0/+16
| | |
* | | Document how it determines when the plugin is runFabian Neundorf2016-08-011-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | If a plugin's target (constructor or function) doesn't satisfy specific parameters, it'll never be called. This documents what the parameters must contain to be run at all. Related to: #159
* | | Bump version for v3.0.33.0.3Ian Cordasco2016-07-301-2/+2
| | | | | | | | | | | | Update release date as well
* | | Reset Application.formatter attribute in init_reportIan Cordasco2016-07-301-0/+5
| | | | | | | | | | | | | | | | | | | | | For our Legacy API users, StyleGuide.init_report should reset the formatter attribute before calling Application.make_formatter(). Closes #200
* | | Re-allow for relative paths for excludeIan Cordasco2016-07-291-6/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, all testing was done from the directory in which the configuration file lived, so this bug went unnoticed. However, if you run Flake8 against its own source from a directory above, you would notice that the patterns in the exclude config value in tox.ini were ignored. This is because we (like any reasonable person) are using relative paths. The path is relative, however, to the directory in which the configuration file was located. So we keep track of which directory that is and use that to normalize the paths in the config file. Yes, there is an unrelated change to our tox.ini in this commit as well. ;-) Closes #194
* | | Open our output file in append mode alwaysIan Cordasco2016-07-291-2/+8
| | | | | | | | | | | | | | | | | | | | | This avoid overwriting portions of our log output when using Flake8 in verbose mode. Closes #193
* | | Add 3.0.3 release note about GitLab#164Marc Abramowitz2016-07-291-1/+8
| | |
* | | Diable multiprocessing behaviour on WindowsIan Cordasco2016-07-291-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | Due to https://bugs.python.org/issue27649, we cannot continue to expect multiprocessing to work as we expect and document it on Windows. As such, we are going to revert back to our previous behaviour of disabling it across all versions of Python on Windows to provide the default expected behaviour of Flake8 on that Operating System.
* | | Allow plugins that are on by default to be ignoredIan Cordasco2016-07-281-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, to ensure that plugins on by default were reported, we added them to the select list. This means that ignoring them became impossible. To accomodate our reporting logic and a user's ability to ignore, we need to keep our select and extended select lists separated. This allows us to have a better understanding of who is selecting what, where, and how and make our decision as to whether or not an error should be reported more wisely. Closes #195
* | | Match noqa for users with explanationsbug/178Ian Cordasco2016-07-282-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | This makes the regular expression a bit more complex, and potentially slower, but it will fix the issue where users had noqa comments with colons followed by explanations. Closes #178
* | | Update version and release notes for 3.0.23.0.2Ian Cordasco2016-07-261-2/+2
| | |
* | | Make the documentation very obviousIan Cordasco2016-07-261-2/+17
| | |
* | | Merge branch 'entry-point' into 'master' Ian Cordasco2016-07-271-1/+5
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Clarify what the X in the entry points does *Description of changes* Previously the `X` wasn't further explained in the documentation on how to register a plugin. This plugs the hole at least for checking plugins. *Related to:* #183 See merge request !93
| * | | Clarify what the X in the entry points doesFabian Neundorf2016-07-261-1/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously the `X` wasn't further explained in the documentation on how to register a plugin. This plugs the hole at least for checking plugins. See also: #183
* | | | Fix handling of logical lines with noqaIan Cordasco2016-07-261-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When attempting to centralize all inline NoQA handling in the StyleGuide we inadvertently broke plugins relying on it in combination with checker state. For example, the check for E402 relies both on NoQA and the state to determine if it has seen a non-import line. Placing NoQA on the sole line that is not an import is more elegant than placing it on each of the following import lines. Closes #186
* | | | Fix zero-indexed column numberingIan Cordasco2016-07-261-0/+3
| | | | | | | | | | | | | | | | | | | | We accidentally changed column numbering from one-indexed to zero-indexed.
* | | | Move the unreleased note to the right versionIan Cordasco2016-07-262-4/+4
|/ / /
* | | Fix project config file discoveryIan Cordasco2016-07-263-2/+12
| |/ |/| | | | | | | | | | | | | | | Flake8 3.0 was stopping once it found the current directory but the historical behaviour (that we didn't intend to break) searched past that (towards root) until it found one of the project/local config file names that could be read. Closes #181
* | Add release notes for 3.0.13.0.1Ian Cordasco2016-07-251-0/+9
| |
* | Merge branch 'file-plugin-docs' into 'master' Ian Cordasco2016-07-251-4/+11
|\ \ | | | | | | | | | | | | | | | | | | Update documentation to separate parameter types This is the documentation update separated from !80 which should be pretty uncontroversial. I already applied the comment on the documentation here. See merge request !83
| * | Update documentation to separate parameter typesFabian Neundorf2016-07-251-4/+11
| | | | | | | | | | | | | | | | | | It updates the documentation to separate which parameters are static and which are changed on each line. Using the latter parameters on plugins which are only run once per file isn't very sensible.
* | | Handle multiline strings with '# noqa'Ian Cordasco2016-07-252-0/+11
|/ / | | | | | | | | | | | | | | | | In Flake8 2.x we allowed people to use # noqa at the end of a multiline string to ignore errors inside the string (e.g., E501). Being blissfully ignorant of this, I never accounted for it in Flake8 3. This fixes the oversight and allows multiline statements to have the # noqa at the end. Closes #177
* | Update release notes and version string for 3.03.0.0Ian Cordasco2016-07-241-18/+6
|/
* Fix typo in documentation using `indect`Fabian Neundorf2016-07-211-1/+1
| | | | | | The documentation for the `FileProcessor` class used `indect_char` while the class itself uses the more sensible name `indent_char`. This updates both the docstring as well as the documentation.
* Trim trailing whitespace in compat docsIan Cordasco2016-07-201-1/+1
|
* Document flake8-polyfill in compatibility sectionIan Cordasco2016-07-202-46/+78
| | | | | | Yesterday we released the flake8-polyfill package to help with Flake8 compatibility issues. This adds documentation to Flake8 to help people use that and to guide them towards it.
* Document Legacy APIIan Cordasco2016-07-141-1/+93
|
* Add new Flake8 classifier to Trove listIan Cordasco2016-07-091-0/+1
|
* Use option name provided by the parserFabian Neundorf2016-07-091-4/+4
| | | | | | | When calling `add_option` it returns an `Option` object which can return the primary name of the option via `get_opt_name`. This should be used primarily in the cross compatible implementation so that the order of parameters does not matter.
* Add 3.0.0b2 release notes3.0.0b2Ian Cordasco2016-06-281-0/+16
|