Skip to content

Commit

Permalink
Update criterion version in docs (#759)
Browse files Browse the repository at this point in the history
* Update criterion version in README.md

* Update criterion version in plots_and_graphs.md

* Update criterion version in custom_test_framework.md

* Update criterion version in html_report.md
  • Loading branch information
FreezyLemon committed Jul 27, 2024
1 parent 8409724 commit 6d28458
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ To start with Criterion.<span></span>rs, add the following to your `Cargo.toml`

```toml
[dev-dependencies]
criterion = { version = "0.4", features = ["html_reports"] }
criterion = { version = "0.5", features = ["html_reports"] }

[[bench]]
name = "my_benchmark"
Expand Down
2 changes: 1 addition & 1 deletion book/src/user_guide/custom_test_framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Once that's installed, add the dependencies to your Cargo.toml:

```toml
[dev-dependencies]
criterion = "0.4"
criterion = "0.5"
criterion-macro = "0.4"
```

Expand Down
2 changes: 1 addition & 1 deletion book/src/user_guide/html_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Starting with Criterion.rs 0.4.0 HTML reports must be explicitly enabled via the `html_reports` [feature](https://doc.rust-lang.org/cargo/reference/features.html#dependency-features):
```toml
[dev-dependencies]
criterion = {version = "0.4.0", features = ["html_reports"] }
criterion = { version = "0.5", features = ["html_reports"] }
```
Criterion.rs can generate an HTML report displaying the results of the benchmark under
`target/criterion/reports/index.html`. By default, the plots are generated using
Expand Down
2 changes: 1 addition & 1 deletion book/src/user_guide/plots_and_graphs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ have introduced a cargo feature for plot and html generation. In order to activa
generation make sure that your `Cargo.toml` activates the feature:

```toml
criterion = { version = "0.4", features = ["html_reports"] }
criterion = { version = "0.5", features = ["html_reports"] }
```

## File Structure
Expand Down

0 comments on commit 6d28458

Please sign in to comment.