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
