Skip to content

Commit

Permalink
Update version numbers in the book (#697)
Browse files Browse the repository at this point in the history
I also added a note to `Cargo.toml` to remind about incrementing these
nubers across the book. This is important as users won’t always take a
note of what is the most recent release is when reading the book.
  • Loading branch information
nagisa committed Aug 15, 2023
1 parent e743d5e commit 4c19e91
Show file tree
Hide file tree
Showing 5 changed files with 238 additions and 235 deletions.
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ authors = [
"Brook Heisler <brookheisler@gmail.com>",
]
name = "criterion"
# When bumping:
#
# * Update version numbers in the book;
version = "0.5.1"
edition = "2018"

Expand Down
2 changes: 1 addition & 1 deletion book/src/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To enable Criterion.rs benchmarks, add the following to your `Cargo.toml` file:

```toml
[dev-dependencies]
criterion = "0.4"
criterion = "0.5.1"

[[bench]]
name = "my_benchmark"
Expand Down
4 changes: 2 additions & 2 deletions book/src/user_guide/custom_test_framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Nightly versions of the rust compiler support custom test frameworks. Criterion.rs provides an
experimental implementation of a custom test framework, meaning that you can use `#[criterion]`
attributes to mark your benchmarks instead of the normal `criterion_group!/criterion_main!` macros.
Right now this requires some unstable features, but at some point in the future
Right now this requires some unstable features, but at some point in the future
`criterion_group!/criterion_main!` will be deprecated and `#[criterion]` will become the standard
way to define a Criterion.rs benchmark. If you'd like to try this feature out early, see the
way to define a Criterion.rs benchmark. If you'd like to try this feature out early, see the
documentation below.

## Using `#[criterion]`
Expand Down
2 changes: 1 addition & 1 deletion book/src/user_guide/migrating_from_libtest.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ We also need to add Criterion.rs to the `dev-dependencies` section of `Cargo.tom

```toml
[dev-dependencies]
criterion = "0.4"
criterion = "0.5.1"
```

The next step is to update the imports:
Expand Down
Loading

0 comments on commit 4c19e91

Please sign in to comment.