Skip to content

Commit

Permalink
Fix doc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
sosthene-nitrokey committed Jan 2, 2024
1 parent f28053a commit 57d6ffd
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/vec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ pub struct VecInner<B: ?Sized + VecDrop> {
/// assert_eq!(*vec, [7, 1, 2, 3]);
/// ```
///
/// In some cases, the const-generic might be cumbersome. `Vec` can coerce into a [`VecView`](VecView) to remove the need for the const-generic:
/// In some cases, the const-generic might be cumbersome. `Vec` can coerce into a [`VecView`] to remove the need for the const-generic:
///
/// ```rust
/// use heapless::{Vec, VecView};
Expand All @@ -75,11 +75,11 @@ pub struct VecInner<B: ?Sized + VecDrop> {
/// ```
pub type Vec<T, const N: usize> = VecInner<[MaybeUninit<T>; N]>;

/// A [`Vec`](Vec) with dynamic capacity
/// A [`Vec`] with dynamic capacity
///
/// [`Vec`](Vec) coerces to `VecView`. `VecView` is `!Sized`, meaning that it can only ever be used through pointer
/// [`Vec`] coerces to `VecView`. `VecView` is `!Sized`, meaning that it can only ever be used through pointer
///
/// Unlike [`Vec`](Vec), `VecView` does not have an `N` const-generic parameter.
/// Unlike [`Vec`], `VecView` does not have an `N` const-generic parameter.
/// This has the ergonomic advantages of making it possible to use functions without needing to know at
/// compile-time the size of the buffers used, for example for use in `dyn` traits.
///
Expand Down

0 comments on commit 57d6ffd

Please sign in to comment.