Skip to content

Commit 94fbfac

Browse files
committed
Updated info reg. option --isMonochrome.
1 parent 2061290 commit 94fbfac

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ A *single* benchmark file may be run as a Dart executable:
7777
The console output is shown above. By default,
7878
the functions [`benchmark`][benchmark] and
7979
[`asyncBenchmark`][asyncBenchmark]
80-
emit benchmark score statistics.
80+
emit benchmark score statistics.
8181
* The first column shows the micro-benchmark runtime, followed by the group
8282
name and the benchmark name.
8383
* The labels of asynchronous groups and benchmarks are marked with an hour-glass
@@ -103,8 +103,7 @@ detected two benchmark files, ran the micro-benchmarks and produced a report.
103103
* The summary shows the total number of completed benchmarks, the number of
104104
benchmarks with errors and the number of groups with errors (that do not
105105
occur within the scope of a benchmark function).
106-
* To show a stack trace for each error, run the benchmark_runner using
107-
the option ``-v`` or `--verbose`.
106+
* To show a stack trace for each error, use the option ``-v`` or `--verbose`.
108107
* The total benchmark run time may be shorter than the sum of the
109108
micro-benchmark run times since each executable benchmark file is run in
110109
a separate process.
@@ -122,7 +121,7 @@ must have write access.
122121

123122
Note: When exporting benchmark scores to a file
124123
and the emitter output is colorized,
125-
it is recommended to use the option `--no-color`, to
124+
it is recommended to use the option `--isMonochrome`, to
126125
avoid spurious characters due to the use of Ansi modifiers.
127126

128127
Since version 0.2.0, the functions [`benchmark`][benchmark] and
@@ -175,9 +174,9 @@ score statistics.
175174
the report provided by [`benchmark_harness`][benchmark_harness] use the
176175
optional argument `report: reportMean`.
177176

178-
- Color output can be switched off by using the option: `--no-color` when
179-
calling the benchmark runner. When executing a single benchmark file the
180-
corresponding option is `--define=noColor=true`.
177+
- Color output can be switched off by using the option: `--isMonochrome` or `-m`
178+
when calling the benchmark runner. When executing a single benchmark file the
179+
corresponding option is `--define=isMonochrome=true`.
181180

182181
- The default colors used to style benchmark reports are best suited
183182
for a dark terminal background.
@@ -195,7 +194,7 @@ error messages and the mean value is altered.
195194
196195
void main(List<String> args) {
197196
// Call function to apply the new custom color profile.
198-
customProfile();
197+
customColorProfile();
199198
}
200199
```
201200

0 commit comments

Comments
 (0)