23 commits

Author	SHA1	Message	Date
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
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
Ville Skyttä	e520c2d936	Implement --extend-ignore ... Refs #365	2018-05-16 08:50:26 +02: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
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
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	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	02bcbee245	Add --stdin-display-name to modify report output	2016-06-06 19:46:29 -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