From 435a200c72471c1d49d314e23bf18b92f5517309 Mon Sep 17 00:00:00 2001 From: Rouven Spreckels Date: Fri, 3 May 2024 21:46:17 +0200 Subject: [PATCH] Fix docs. --- src/bits/mod.rs | 8 ++++---- src/real/mod.rs | 8 ++++---- src/simd_bits/mod.rs | 8 ++++---- src/simd_real/mod.rs | 8 ++++---- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/bits/mod.rs b/src/bits/mod.rs index fd2b610..784c2d8 100644 --- a/src/bits/mod.rs +++ b/src/bits/mod.rs @@ -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 @@ -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 diff --git a/src/real/mod.rs b/src/real/mod.rs index 4c722cb..b44ee88 100644 --- a/src/real/mod.rs +++ b/src/real/mod.rs @@ -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 @@ -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 diff --git a/src/simd_bits/mod.rs b/src/simd_bits/mod.rs index 38d8576..d3bdb12 100644 --- a/src/simd_bits/mod.rs +++ b/src/simd_bits/mod.rs @@ -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 @@ -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 diff --git a/src/simd_real/mod.rs b/src/simd_real/mod.rs index 88a32fc..a98d88d 100644 --- a/src/simd_real/mod.rs +++ b/src/simd_real/mod.rs @@ -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 @@ -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