Commit f6b8d4b7 authored by Nakamura Shuta's avatar Nakamura Shuta Committed by Miguel Ojeda
Browse files

rust: num: fix typos in Bounded documentation 



Fix several typos and grammatical errors in the Bounded type documentation:
- "less significant bits" -> "least significant bits"
- "with in" -> "within"
- "withheld" -> "upheld"
- "//  This" -> "// This" (double space)
- "doesn't fits" -> "doesn't fit" (2 occurrences)

Reported-by: default avatarMiguel Ojeda <ojeda@kernel.org>
Closes: https://github.com/Rust-for-Linux/linux/issues/1210


Signed-off-by: default avatarNakamura Shuta <nakamura.shuta@gmail.com>
Acked-by: default avatarAlexandre Courbot <acourbot@nvidia.com>
Acked-by: default avatarYury Norov (NVIDIA) <yury.norov@nvidia.com>
Fixes: 01e345e8 ("rust: num: add Bounded integer wrapping type")
Link: https://patch.msgid.link/20251204024336.246587-1-nakamura.shuta@gmail.com


[ Removed Link tag due to duplicated URL. - Miguel ]
Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 1e4e2a84

rust/kernel/num/bounded.rs

+6 −6
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ fn fits_within<T: Integer>(value: T, num_bits: u32) -> bool { 
    fits_within!(value, T, num_bits)

}



/// An integer value that requires only the `N` less significant bits of the wrapped type to be

/// An integer value that requires only the `N` least significant bits of the wrapped type to be

/// encoded.

///

/// This limits the number of usable bits in the wrapped integer type, and thus the stored value to
@@ -56,7 +56,7 @@ fn fits_within<T: Integer>(value: T, num_bits: u32) -> bool { 
/// # Examples

///

/// The preferred way to create values is through constants and the [`Bounded::new`] family of

/// constructors, as they trigger a build error if the type invariants cannot be withheld.

/// constructors, as they trigger a build error if the type invariants cannot be upheld.

///

/// ```

/// use kernel::num::Bounded;
@@ -221,7 +221,7 @@ fn fits_within<T: Integer>(value: T, num_bits: u32) -> bool { 
/// let v: Option<Bounded<u16, 8>> = 128u32.try_into_bounded();

/// assert_eq!(v.as_deref().copied(), Some(128));

///

/// // Fails because `128` doesn't fits into 6 bits.

/// // Fails because `128` doesn't fit into 6 bits.

/// let v: Option<Bounded<u16, 6>> = 128u32.try_into_bounded();

/// assert_eq!(v, None);

/// ```
@@ -501,7 +501,7 @@ fn deref(&self) -> &Self::Target { 
/// let v: Option<Bounded<u16, 8>> = 128u32.try_into_bounded();

/// assert_eq!(v.as_deref().copied(), Some(128));

///

/// // Fails because `128` doesn't fits into 6 bits.

/// // Fails because `128` doesn't fit into 6 bits.

/// let v: Option<Bounded<u16, 6>> = 128u32.try_into_bounded();

/// assert_eq!(v, None);

/// ```