Skip to content

Commit 714657a

Browse files
committed
remove easily-broken example permalinks
1 parent c9ddd57 commit 714657a

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ See examples in `new` method documentation:
2828
- [`Interp3D::new`](https://docs.rs/ninterp/latest/ninterp/three/struct.Interp3D.html#method.new)
2929
- [`InterpND::new`](https://docs.rs/ninterp/latest/ninterp/n/struct.InterpND.html#method.new)
3030

31-
Also see the [`examples`](https://github.com/NREL/ninterp/tree/0c664523198bee063da51dc2524cbe75e8882c2d/examples) directory for advanced examples:
32-
- Strategy dynamic dispatch: [`dynamic_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/dynamic_strategy.rs)
31+
Also see the [`examples`](examples) directory for advanced examples:
32+
- Strategy dynamic dispatch: [`dynamic_strategy.rs`](examples/dynamic_strategy.rs)
3333

3434
By default, construction of interpolators uses *static dispatch*,
3535
meaning strategy concrete types are determined at compilation.
@@ -38,11 +38,11 @@ Also see the [`examples`](https://github.com/NREL/ninterp/tree/0c664523198bee063
3838
use *dynamic dispatch* by providing a boxed trait object
3939
`Box<dyn Strategy1D>`/etc. to the `new` method.
4040

41-
- Interpolator dynamic dispatch using `Box<dyn Interpolator>`: [`dynamic_interpolator.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/dynamic_interpolator.rs)
41+
- Interpolator dynamic dispatch using `Box<dyn Interpolator>`: [`dynamic_interpolator.rs`](examples/dynamic_interpolator.rs)
4242

43-
- Defining custom strategies: [`custom_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/custom_strategy.rs)
43+
- Defining custom strategies: [`custom_strategy.rs`](examples/custom_strategy.rs)
4444

45-
- Using transmutable (transparent) types, such as `uom::si::Quantity`: [`uom.rs`](https://github.com/NREL/ninterp/blob/de2c770dc3614ba43af9e015481fecdc20538380/examples/uom.rs)
45+
- Using transmutable (transparent) types, such as `uom::si::Quantity`: [`uom.rs`](examples/uom.rs)
4646

4747
## Overview
4848
A prelude module has been defined:
@@ -84,7 +84,7 @@ Not all interpolation strategies are implemented for every dimensionality.
8484
`Linear` and `Nearest` are implemented for all dimensionalities.
8585

8686
Custom strategies can be defined. See
87-
[`examples/custom_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/custom_strategy.rs)
87+
[`examples/custom_strategy.rs`](examples/custom_strategy.rs)
8888
for an example.
8989

9090
### Extrapolation

src/lib.rs

+13-9
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@
2626
//! - [`Interp3D::new`](`interpolator::Interp3D::new`)
2727
//! - [`InterpND::new`](`interpolator::InterpND::new`)
2828
//!
29-
//! Also see the [`examples`](https://github.com/NREL/ninterp/tree/0c664523198bee063da51dc2524cbe75e8882c2d/examples)
30-
//! directory for advanced examples:
31-
//! - Strategy dynamic dispatch:
32-
//! [`dynamic_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/dynamic_strategy.rs)
29+
//! Also see the `examples` directory for advanced examples:
30+
//! - `dynamic_strategy.rs`
31+
//!
32+
//! Strategy dynamic dispatch
3333
//!
3434
//! By default, construction of interpolators uses *static dispatch*,
3535
//! meaning strategy concrete types are determined at compilation.
@@ -38,13 +38,17 @@
3838
//! use *dynamic dispatch* by providing a boxed trait object
3939
//! `Box<dyn Strategy1D>`/etc. to the `new` method.
4040
//!
41-
//! - Interpolator dynamic dispatch using `Box<dyn Interpolator>`:
42-
//! [`dynamic_interpolator.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/dynamic_interpolator.rs)
41+
//! - `dynamic_interpolator.rs`
42+
//!
43+
//! Interpolator dynamic dispatch using `Box<dyn Interpolator>`
44+
//!
45+
//! - `custom_strategy.rs`
46+
//!
47+
//! Defining custom strategies
4348
//!
44-
//! - Defining custom strategies:
45-
//! [`custom_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/custom_strategy.rs)
49+
//! - `uom.rs`
4650
//!
47-
//! - Using transmutable (transparent) types, such as `uom::si::Quantity`: [`uom.rs`](https://github.com/NREL/ninterp/blob/de2c770dc3614ba43af9e015481fecdc20538380/examples/uom.rs)
51+
//! Using transmutable (transparent) types, such as `uom::si::Quantity`
4852
//!
4953
//! # Overview
5054
//! A prelude module has been defined:

0 commit comments

Comments
 (0)