diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-08-06 14:16:08 -0500 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-08-07 12:31:14 -0500 |
| commit | f67f481beea1f32e503d346e9d4d3f2f2a8b2ebe (patch) | |
| tree | a147072597dfff8d3df7333a744573f29ef95fee /docs/source/user | |
| parent | f768ed6fd0101de656e19d3029952e69a437549e (diff) | |
| download | flake8-f67f481beea1f32e503d346e9d4d3f2f2a8b2ebe.tar.gz | |
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
Diffstat (limited to 'docs/source/user')
| -rw-r--r-- | docs/source/user/options.rst | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/source/user/options.rst b/docs/source/user/options.rst index acaa67c..c139f69 100644 --- a/docs/source/user/options.rst +++ b/docs/source/user/options.rst @@ -728,3 +728,51 @@ flake8 --benchmark dir/ This **can not** be specified in config files. + + +.. option:: --bug-report + + Generate information necessary to file a complete bug report for Flake8. + This will pretty-print a JSON blob that should be copied and pasted into a + bug report for Flake8. + + Command-line usage: + + .. prompt:: bash + + flake8 --bug-report + + The output should look vaguely like: + + .. code-block:: js + + { + "dependencies": [ + { + "dependency": "setuptools", + "version": "25.1.1" + } + ], + "platform": { + "python_implementation": "CPython", + "python_version": "2.7.12", + "system": "Darwin" + }, + "plugins": [ + { + "plugin": "mccabe", + "version": "0.5.1" + }, + { + "plugin": "pycodestyle", + "version": "2.0.0" + }, + { + "plugin": "pyflakes", + "version": "1.2.3" + } + ], + "version": "3.1.0.dev0" + } + + This **can not** be specified in config files. |