From 16f58005bf09100b4ffb2a9337287ca30667c4d3 Mon Sep 17 00:00:00 2001 From: Ian Cordasco Date: Sun, 19 Jun 2016 20:41:19 -0500 Subject: [PATCH] Add --benchmark option documentation --- docs/source/user/options.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) 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.