Add --benchmark option documentation

This commit is contained in:
Ian Cordasco 2016-06-19 20:41:19 -05:00
parent adedd6c5cf
commit 16f58005bf
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A

View file

@ -706,3 +706,24 @@
exclude_in_doctest =
dir/subdir/file.py,
dir/other/file.py
.. option:: --benchmark
Collect and print benchmarks for this run of Flake8. This aggregates the
total number of:
- tokens
- physical lines
- logical lines
- files
and the number of elapsed seconds.
Command-line usage:
.. prompt:: bash
flake8 --benchmark dir/
This **can not** be specified in config files.