Skip to content

Commit c56485f

Browse files
committed
docs: Mark Master API Docs links that need to be updated
1 parent 86526a4 commit c56485f

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

book/src/criterion_rs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Criterion.rs is free and open source. You can find the source on [GitHub](https:
88

99
## API Docs ##
1010

11-
In addition to this book, you may also wish to read [the API documentation](http://bheisler.github.io/criterion.rs/criterion/).
11+
In addition to this book, you may also wish to read [the API documentation](http://criterion-rs.github.io/criterion/FIXME).
1212

1313
## License ##
1414

book/src/getting_started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ use mycrate::fibonacci;
8585
```
8686

8787
First, we declare the criterion crate and import the [Criterion
88-
type](http://bheisler.github.io/criterion.rs/criterion/struct.Criterion.html). Criterion is the
88+
type](http://criterion-rs.github.io/criterion/struct.Criterion.html.FIXME). Criterion is the
8989
main type for the Criterion.rs library. It provides methods to configure and define groups of
9090
benchmarks. We also import `black_box`, which will be described later.
9191

@@ -109,7 +109,7 @@ but it should be clear and understandable.
109109
This is where the real work happens. The `bench_function` method defines a benchmark with a name
110110
and a closure. The name should be unique among all of the benchmarks for your project. The closure
111111
must accept one argument, a
112-
[Bencher](http://bheisler.github.io/criterion.rs/criterion/struct.Bencher.html). The bencher
112+
[Bencher](http://criterion-rs.github.io/criterion/struct.Bencher.html.FIXME). The bencher
113113
performs the benchmark - in this case, it simply calls our `fibonacci` function in a loop. There
114114
are a number of other ways to perform benchmarks, including the option to benchmark with arguments,
115115
and to compare the performance of two functions. See the API documentation for details on all of
@@ -126,10 +126,10 @@ criterion_main!(benches);
126126
```
127127

128128
Here we invoke the `criterion_group!`
129-
[(link)](http://bheisler.github.io/criterion.rs/criterion/macro.criterion_group.html) macro to
129+
[(link)](http://criterion-rs.github.io/criterion/macro.criterion_group.html.FIXME) macro to
130130
generate a benchmark group called benches, containing the `criterion_benchmark` function defined
131131
earlier. Finally, we invoke the `criterion_main!`
132-
[(link)](http://bheisler.github.io/criterion.rs/criterion/macro.criterion_main.html) macro to
132+
[(link)](http://criterion-rs.github.io/criterion/macro.criterion_main.html.FIXME) macro to
133133
generate a main function which executes the `benches` group. See the API documentation for more
134134
information on these macros.
135135

book/src/user_guide/timing_loops.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Timing Loops
22

3-
The [`Bencher`](https://bheisler.github.io/criterion.rs/criterion/struct.Bencher.html) structure
3+
The [`Bencher`](https://criterion-rs.github.io/criterion/struct.Bencher.html.FIXME) structure
44
provides a number of functions which implement different timing loops for measuring the performance
55
of a function. This page discusses how these timing loops work and which one is appropriate for
66
different situations.
@@ -41,21 +41,21 @@ could run out of memory while collecting the values to drop.
4141
timing loops take two closures rather than one. The first closure takes no arguments and returns
4242
a value of type `T` - this is used to generate setup data. For example, the setup function might
4343
clone a vector of unsorted data for use in benchmarking a sorting function. The second closure
44-
is the function to benchmark, and it takes a `T` (for `iter_batched`) or `&mut T` (for
44+
is the function to benchmark, and it takes a `T` (for `iter_batched`) or `&mut T` (for
4545
`iter_batched_ref`).
4646

4747
These two timing loops generate a batch of inputs and measure the time to execute the benchmark on
4848
all values in the batch. As with `iter_with_large_drop` they also collect the values returned from
4949
the benchmark into a `Vec` and drop it later without timing the drop. Then another batch of inputs
5050
is generated and the process is repeated until enough iterations of the benchmark have been measured.
51-
Keep in mind that this is only necessary if the benchmark modifies the input - if the input is
51+
Keep in mind that this is only necessary if the benchmark modifies the input - if the input is
5252
constant then one input value can be reused and the benchmark should use `iter` instead.
5353

5454
Both timing loops accept a third parameter which controls how large a batch is. If the batch size
5555
is too large, we might run out of memory generating the inputs and collecting the outputs. If it's
5656
too small, we could introduce more measurement overhead than is necessary. For ease of use, Criterion
57-
provides three pre-defined choices of batch size, defined by the
58-
[`BatchSize`](https://bheisler.github.io/criterion.rs/criterion/enum.BatchSize.html) enum -
57+
provides three pre-defined choices of batch size, defined by the
58+
[`BatchSize`](https://criterion-rs.github.io/criterion/enum.BatchSize.html.FIXME) enum -
5959
`SmallInput`, `LargeInput` and `PerIteration`. It is also possible (though not recommended) to set
6060
the batch size manually.
6161

@@ -88,7 +88,7 @@ more control over the batch size which may be necessary in some situations.
8888
## `iter_custom`
8989

9090
This is a special "timing loop" that relies on you to do your own timing. Where the other timing
91-
loops take a lambda to call N times in a loop, this takes a lambda of the form
91+
loops take a lambda to call N times in a loop, this takes a lambda of the form
9292
`FnMut(iters: u64) -> M::Value` - meaning that it accepts the number of iterations and returns
9393
the measured value. Typically, this will be a `Duration` for the default `WallTime` measurement,
9494
but it may be other types for other measurements (see the

0 commit comments

Comments
 (0)