Skip to content

Commit a6d7650

Browse files
authored
improve documentation regarding the html reports feature (#662)
1 parent 27642b4 commit a6d7650

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ To start with Criterion.<span></span>rs, add the following to your `Cargo.toml`
5656

5757
```toml
5858
[dev-dependencies]
59-
criterion = "0.4"
59+
criterion = { version = "0.4", features = ["html_reports"] }
6060

6161
[[bench]]
6262
name = "my_benchmark"
@@ -107,7 +107,7 @@ First, thank you for contributing.
107107
One great way to contribute to Criterion.<span></span>rs is to use it for your own benchmarking needs and report your experiences, file and comment on issues, etc.
108108

109109
Code or documentation improvements in the form of pull requests are also welcome. If you're not
110-
sure what to work on, try checking the
110+
sure what to work on, try checking the
111111
[Beginner label](https://github.com/bheisler/criterion.rs/issues?q=is%3Aissue+is%3Aopen+label%3ABeginner).
112112

113113
If your issues or pull requests have no response after a few days, feel free to ping me (@bheisler).

book/src/user_guide/plots_and_graphs.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ understanding of the behavior of the benchmark. These charts will be generated w
66
it is not available. The examples below were generated using the gnuplot backend, but the plotters
77
ones are similar.
88

9+
Note that in older versions of criterion.rs html reports were enabled by default. Recent versions
10+
have introduced a cargo feature for plot and html generation. In order to activate the html report
11+
generation make sure that your `Cargo.toml` activates the feature:
12+
13+
```toml
14+
criterion = { version = "0.4", features = ["html_reports"] }
15+
```
16+
917
## File Structure
1018

1119
The plots and saved data are stored under `target/criterion/$BENCHMARK_NAME/`. Here's an example of

0 commit comments

Comments
 (0)