From 6d284586fb5b51de8e986ca5d57acd79cdb4bca7 Mon Sep 17 00:00:00 2001 From: FreezyLemon Date: Sat, 27 Jul 2024 09:57:13 +0200 Subject: [PATCH] Update criterion version in docs (#759) * 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 --- README.md | 2 +- book/src/user_guide/custom_test_framework.md | 2 +- book/src/user_guide/html_report.md | 2 +- book/src/user_guide/plots_and_graphs.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0c440790d..635482e5c 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ To start with Criterion.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" diff --git a/book/src/user_guide/custom_test_framework.md b/book/src/user_guide/custom_test_framework.md index 72618b420..5d4676563 100644 --- a/book/src/user_guide/custom_test_framework.md +++ b/book/src/user_guide/custom_test_framework.md @@ -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" ``` diff --git a/book/src/user_guide/html_report.md b/book/src/user_guide/html_report.md index e6de42bd6..bc36e4064 100644 --- a/book/src/user_guide/html_report.md +++ b/book/src/user_guide/html_report.md @@ -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 diff --git a/book/src/user_guide/plots_and_graphs.md b/book/src/user_guide/plots_and_graphs.md index 5c292c77a..31308011e 100644 --- a/book/src/user_guide/plots_and_graphs.md +++ b/book/src/user_guide/plots_and_graphs.md @@ -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