Regenerate documentation with latest cargo-onedoc

Author: rossmacarthur

README.md

@@ -1,12 +1,12 @@
-<!-- Generated by cargo-onedoc. DO NOT EDIT. -->
+<!-- Generated by cargo-onedoc v0.2.2. DO NOT EDIT. -->
 
 # vectrix
 
 [![Crates.io Version](https://badgers.space/crates/version/vectrix)](https://crates.io/crates/vectrix)
 [![Docs.rs Latest](https://badgers.space/badge/docs.rs/latest/blue)](https://docs.rs/vectrix)
 [![Build Status](https://badgers.space/github/checks/rossmacarthur/vectrix?label=build)](https://github.com/rossmacarthur/vectrix/actions/workflows/build.yaml)
 
-This crate provides a stack-allocated, constant-size [`Matrix<T, M, N>`][matrix]
+This crate provides a stack-allocated, constant-size [`Matrix<T, M, N>`][Matrix]
 type implemented using const generics.
 
 ## 🚀 Getting started
@@ -27,21 +27,21 @@ cargo add vectrix --no-default-features --features=macro
 
 ### Types
 
-The base [`Matrix<T, M, N>`][matrix] type represents a matrix with `M` rows and `N`
+The base [`Matrix<T, M, N>`][Matrix] type represents a matrix with `M` rows and `N`
 columns. This type is a backed by an array of arrays. The data is stored in
 column-major order. Some convenient aliases are provided for common
 matrices, like vectors.
 
-- [`Matrix<T, M, N>`][matrix] → a generic matrix type with `M` rows and `N` columns.
-- [`Vector<T, M>`][vector] → a column vector with `M` rows.
-- [`RowVector<T, N>`][rowvector] → a row vector with `N` columns.
+- [`Matrix<T, M, N>`][Matrix] → a generic matrix type with `M` rows and `N` columns.
+- [`Vector<T, M>`][Vector] → a column vector with `M` rows.
+- [`RowVector<T, N>`][RowVector] → a row vector with `N` columns.
 
 ### Macros
 
 Macros are provided for easy construction of the provided types. These
 macros will also work in `const` contexts.
 
-- The [`matrix!`][matrix-1] macro can be used to construct a new [`Matrix`][matrix] of any
+- The [`matrix!`][matrix] macro can be used to construct a new [`Matrix`][Matrix] of any
   size.
 
   ```rust
@@ -54,7 +54,7 @@ macros will also work in `const` contexts.
   In the above example `matrix` is a `Matrix<_, 2, 3>` type, having 2 rows and
   3 columns.
 
-- The [`vector!`][vector-1] and [`row_vector!`][row_vector] macros can be used to to construct
+- The [`vector!`][vector] and [`row_vector!`][row_vector] macros can be used to to construct
   column and row vectors respectively.
 
   ```rust
@@ -71,16 +71,16 @@ macros will also work in `const` contexts.
 
 Commonly used constructors are listed below.
 
-- [`::zero()`][zero] → constructs a new matrix filled with
-  [`T::zero()`][tzero].
-- [`::identity()`][identity] → constructs a new identity matrix.
-- [`::repeat(..)`][repeat] → constructs a new matrix filled with
+- [`::zero()`][::zero] → constructs a new matrix filled with
+  [`T::zero()`][T::zero].
+- [`::identity()`][::identity] → constructs a new identity matrix.
+- [`::repeat(..)`][::repeat] → constructs a new matrix filled with
   the provided value.
-- [`::repeat_with(..)`][repeat_with] → constructs a new matrix
+- [`::repeat_with(..)`][::repeat_with] → constructs a new matrix
   filled with values computed by the provided closure.
-- [`::from_iter(..)`][from_iter] → constructs a
+- [`::from_iter(..)`][::from_iter] → constructs a
   new matrix from an iterator.
-- [`::new(..)`][new] → constructs a new vector using the
+- [`::new(..)`][::new] → constructs a new vector using the
   provided components.
 
 ### Accessing elements
@@ -180,7 +180,7 @@ assert_eq!(m.as_slice(), &[1, 2, 3, 4, 5, 6]);
 
 ### Debug
 
-The [`Debug`][debug] implementation will print out vectors as
+The [`Debug`][Debug] implementation will print out vectors as
 lists and matrices as a list of lists in column-major order.
 
 ```rust
@@ -199,10 +199,10 @@ matrix: [[1, 3], [2, 4]]
 
 ### Display
 
-The [`Display`][display] implementation will print out the
+The [`Display`][Display] implementation will print out the
 matrix in the traditional box bracket format. Precision is supported as well
 as most of the other formatting traits like
-[`LowerHex`][lowerhex].
+[`LowerHex`][LowerHex].
 
 ```rust
 let cv = vector![1.1, 2.0];
@@ -236,7 +236,7 @@ matrix:
 
 ### Operations
 
-[`Matrix`][matrix] implements many built-in operators. With scalar operands almost
+[`Matrix`][Matrix] implements many built-in operators. With scalar operands almost
 all operators are implemented and they simply apply the operation to each
 element in the matrix. Unary operators will do the equivalent. In the
 following example each element in the matrix is multiplied by 2.
@@ -253,7 +253,7 @@ let exp = matrix![
 assert_eq!(m * 2, exp);
 ```
 
-[`Matrix`][matrix] supports addition and subtraction with same size matrices for
+[`Matrix`][Matrix] supports addition and subtraction with same size matrices for
 element-wise addition and subtraction. In the following example a matrix
 is added to itself.
 
@@ -276,30 +276,30 @@ This project is distributed under the terms of both the MIT license and the Apac
 See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
 
 
+[::from_iter]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.from_iter
+[::identity]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.identity
+[::new]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.new
+[::repeat]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.repeat
+[::repeat_with]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.repeat_with
+[::zero]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.zero
+[Debug]: https://doc.rust-lang.org/stable/std/fmt/trait.Debug.html
+[Display]: https://doc.rust-lang.org/stable/std/fmt/trait.Display.html
+[LowerHex]: https://doc.rust-lang.org/stable/std/fmt/trait.LowerHex.html
+[Matrix]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html
+[RowVector]: https://docs.rs/vectrix/latest/vectrix/type.RowVector.html
+[T::zero]: https://docs.rs/vectrix/latest/vectrix/trait.Zero.html#tymethod.zero
+[Vector]: https://docs.rs/vectrix/latest/vectrix/type.Vector.html
 [as_mut_slice]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.as_mut_slice
 [as_slice]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.as_slice
 [column]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.column
-[debug]: https://doc.rust-lang.org/stable/std/fmt/trait.Debug.html
-[display]: https://doc.rust-lang.org/stable/std/fmt/trait.Display.html
-[from_iter]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.from_iter
-[identity]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.identity
 [into_iter]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.into_iter
 [iter]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.iter
 [iter_columns]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.iter_columns
 [iter_columns_mut]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.iter_columns_mut
 [iter_mut]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.iter_mut
 [iter_rows]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.iter_rows
 [iter_rows_mut]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.iter_rows_mut
-[lowerhex]: https://doc.rust-lang.org/stable/std/fmt/trait.LowerHex.html
-[matrix]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html
-[matrix-1]: https://docs.rs/vectrix/latest/vectrix/macro.matrix.html
-[new]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.new
-[repeat]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.repeat
-[repeat_with]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.repeat_with
+[matrix]: https://docs.rs/vectrix/latest/vectrix/macro.matrix.html
 [row]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.row
 [row_vector]: https://docs.rs/vectrix/latest/vectrix/macro.row_vector.html
-[rowvector]: https://docs.rs/vectrix/latest/vectrix/type.RowVector.html
-[tzero]: https://docs.rs/vectrix/latest/vectrix/trait.Zero.html#tymethod.zero
-[vector]: https://docs.rs/vectrix/latest/vectrix/type.Vector.html
-[vector-1]: https://docs.rs/vectrix/latest/vectrix/macro.vector.html
-[zero]: https://docs.rs/vectrix/latest/vectrix/struct.Matrix.html#method.zero
+[vector]: https://docs.rs/vectrix/latest/vectrix/macro.vector.html

crates/stride/README.md

@@ -1,4 +1,4 @@
-<!-- Generated by cargo-onedoc. DO NOT EDIT. -->
+<!-- Generated by cargo-onedoc v0.2.2. DO NOT EDIT. -->
 
 # stride
 
@@ -20,10 +20,10 @@ and indexing. Method names are similar to those of the slice type.
 
 Where you want a strided slice use:
 
-- `::new()` to construct a `&Stride<T, S>` that
-  wraps a `&[T]`.
-- `::new_mut()` to construct a
-  `&mut Stride<T, S>` that wraps a `&mut [T]`.
+- `::new()``Stride::new` to construct a `&Stride<T, S>``Stride` that
+  wraps a `&[T]``slice`.
+- `::new_mut()``Stride::new_mut` to construct a
+  `&mut Stride<T, S>``Stride` that wraps a `&mut [T]``slice`.
 
 ```rust
 use stride::Stride;