doc microbenchmark (dart-lang#1839)

* doc microbenchmark * - lib.
5lineofcode · Nov 14, 2019 · d998626 · d998626
1 parent 827a5f6
commit d998626
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/tool/benchmark.dart b/tool/benchmark.dart
@@ -8,6 +8,11 @@ import 'package:linter/src/utils.dart';
 
 import '../test/ascii_utils_test.dart' as utils_test;
 
+/// Micro-benchmarks.
+///
+/// More comprehensive benchmarks are run like so:
+///
+///     dart bin/linter.dart --benchmark -q -c example/all.yaml .
 main() {
   FileNameRegexpTestBenchmarkGood().report();
   FileNameCharLoopTestBenchmarkGood().report();