Skip to content

Commit

Permalink
Fix docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
n3vu0r committed May 3, 2024
1 parent bc8cf12 commit 435a200
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions src/bits/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,12 @@ where

/// Split a slice into a prefix, a middle of aligned SIMD vectors, and a suffix.
///
/// You're only assured thatc`self.len() == prefix.len() + middle.len() * N + suffix.len()`.
/// You're only assured that `slice.len() == prefix.len() + middle.len() * N + suffix.len()`.
///
/// Notably, all of the following are possible:
///
/// * `prefix.len() >= N`,
/// * `middle.is_empty()` despite `self.len() >= 3 * N`,
/// * `middle.is_empty()` despite `slice.len() >= 3 * N`,
/// * `suffix.len() >= N`.
///
/// That said, this is a safe method, so if you're only writing safe code, then this can at most
Expand All @@ -119,12 +119,12 @@ where
/// Split a mutable slice into a mutable prefix, a middle of aligned SIMD vectors, and a mutable
/// suffix.
///
/// You're only assured that `self.len() == prefix.len() + middle.len() * N + suffix.len()`.
/// You're only assured that `self.slice() == prefix.len() + middle.len() * N + suffix.len()`.
///
/// Notably, all of the following are possible:
///
/// * `prefix.len() >= N`,
/// * `middle.is_empty()` despite `self.len() >= 3 * N`,
/// * `middle.is_empty()` despite `self.slice() >= 3 * N`,
/// * `suffix.len() >= N`.
///
/// That said, this is a safe method, so if you're only writing safe code, then this can at most
Expand Down
8 changes: 4 additions & 4 deletions src/real/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -454,12 +454,12 @@ where

/// Split a slice into a prefix, a middle of aligned SIMD vectors, and a suffix.
///
/// You're only assured thatc`self.len() == prefix.len() + middle.len() * N + suffix.len()`.
/// You're only assured that `slice.len() == prefix.len() + middle.len() * N + suffix.len()`.
///
/// Notably, all of the following are possible:
///
/// * `prefix.len() >= N`,
/// * `middle.is_empty()` despite `self.len() >= 3 * N`,
/// * `middle.is_empty()` despite `slice.len() >= 3 * N`,
/// * `suffix.len() >= N`.
///
/// That said, this is a safe method, so if you're only writing safe code, then this can at most
Expand All @@ -480,12 +480,12 @@ where
/// Split a mutable slice into a mutable prefix, a middle of aligned SIMD vectors, and a mutable
/// suffix.
///
/// You're only assured that `self.len() == prefix.len() + middle.len() * N + suffix.len()`.
/// You're only assured that `slice.len() == prefix.len() + middle.len() * N + suffix.len()`.
///
/// Notably, all of the following are possible:
///
/// * `prefix.len() >= N`,
/// * `middle.is_empty()` despite `self.len() >= 3 * N`,
/// * `middle.is_empty()` despite `slice.len() >= 3 * N`,
/// * `suffix.len() >= N`.
///
/// That said, this is a safe method, so if you're only writing safe code, then this can at most
Expand Down
8 changes: 4 additions & 4 deletions src/simd_bits/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,12 @@ where

/// Split a slice into a prefix, a middle of aligned SIMD vectors, and a suffix.
///
/// You're only assured thatc`self.len() == prefix.len() + middle.len() * N + suffix.len()`.
/// You're only assured that `slice.len() == prefix.len() + middle.len() * N + suffix.len()`.
///
/// Notably, all of the following are possible:
///
/// * `prefix.len() >= N`,
/// * `middle.is_empty()` despite `self.len() >= 3 * N`,
/// * `middle.is_empty()` despite `slice.len() >= 3 * N`,
/// * `suffix.len() >= N`.
///
/// That said, this is a safe method, so if you're only writing safe code, then this can at most
Expand All @@ -98,12 +98,12 @@ where
/// Split a mutable slice into a mutable prefix, a middle of aligned SIMD vectors, and a mutable
/// suffix.
///
/// You're only assured that `self.len() == prefix.len() + middle.len() * N + suffix.len()`.
/// You're only assured that `slice.len() == prefix.len() + middle.len() * N + suffix.len()`.
///
/// Notably, all of the following are possible:
///
/// * `prefix.len() >= N`,
/// * `middle.is_empty()` despite `self.len() >= 3 * N`,
/// * `middle.is_empty()` despite `slice.len() >= 3 * N`,
/// * `suffix.len() >= N`.
///
/// That said, this is a safe method, so if you're only writing safe code, then this can at most
Expand Down
8 changes: 4 additions & 4 deletions src/simd_real/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,12 @@ where

/// Split a slice into a prefix, a middle of aligned SIMD vectors, and a suffix.
///
/// You're only assured thatc`self.len() == prefix.len() + middle.len() * N + suffix.len()`.
/// You're only assured that `slice.len() == prefix.len() + middle.len() * N + suffix.len()`.
///
/// Notably, all of the following are possible:
///
/// * `prefix.len() >= N`,
/// * `middle.is_empty()` despite `self.len() >= 3 * N`,
/// * `middle.is_empty()` despite `slice.len() >= 3 * N`,
/// * `suffix.len() >= N`.
///
/// That said, this is a safe method, so if you're only writing safe code, then this can at most
Expand All @@ -123,12 +123,12 @@ where
/// Split a mutable slice into a mutable prefix, a middle of aligned SIMD vectors, and a mutable
/// suffix.
///
/// You're only assured that `self.len() == prefix.len() + middle.len() * N + suffix.len()`.
/// You're only assured that `slice.len() == prefix.len() + middle.len() * N + suffix.len()`.
///
/// Notably, all of the following are possible:
///
/// * `prefix.len() >= N`,
/// * `middle.is_empty()` despite `self.len() >= 3 * N`,
/// * `middle.is_empty()` despite `slice.len() >= 3 * N`,
/// * `suffix.len() >= N`.
///
/// That said, this is a safe method, so if you're only writing safe code, then this can at most
Expand Down

0 comments on commit 435a200

Please sign in to comment.