summaryrefslogtreecommitdiff
path: root/docs/source/user
diff options
context:
space:
mode:
authorIan Cordasco <graffatcolmingov@gmail.com>2016-06-19 20:41:19 -0500
committerIan Cordasco <graffatcolmingov@gmail.com>2016-06-19 20:41:19 -0500
commit16f58005bf09100b4ffb2a9337287ca30667c4d3 (patch)
tree2af65b7dfbde67b3c964e36fab46b3b3e7efa005 /docs/source/user
parentadedd6c5cfd705d01e79a0f673ed95ee4bb26e08 (diff)
downloadflake8-16f58005bf09100b4ffb2a9337287ca30667c4d3.tar.gz
Add --benchmark option documentation
Diffstat (limited to 'docs/source/user')
-rw-r--r--docs/source/user/options.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/source/user/options.rst b/docs/source/user/options.rst
index ecbf52d..7f79e61 100644
--- a/docs/source/user/options.rst
+++ b/docs/source/user/options.rst
@@ -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.