From 5e66561085613dbd67ae36ea5b82622bea64ca3d Mon Sep 17 00:00:00 2001 From: Oliver Rockstedt Date: Mon, 7 Oct 2024 11:22:01 +0200 Subject: [PATCH] Rustdoc clippy and typo fixes --- src/indexmap.rs | 2 +- src/mpmc.rs | 4 ++-- src/spsc.rs | 4 ++-- src/string/mod.rs | 6 +++--- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/indexmap.rs b/src/indexmap.rs index 80efe62e73..05f1ae10c6 100644 --- a/src/indexmap.rs +++ b/src/indexmap.rs @@ -1125,7 +1125,7 @@ where /// Remove the key-value pair equivalent to `key` and return its value. /// /// Like `Vec::swap_remove`, the pair is removed by swapping it with the last element of the map - /// and popping it off. **This perturbs the postion of what used to be the last element!** + /// and popping it off. **This perturbs the position of what used to be the last element!** /// /// Return `None` if `key` is not in map. /// diff --git a/src/mpmc.rs b/src/mpmc.rs index caef2caf9d..a685816b6f 100644 --- a/src/mpmc.rs +++ b/src/mpmc.rs @@ -67,10 +67,10 @@ //! not. //! - All execution times are in clock cycles. 1 clock cycle = 125 ns. //! - Execution time is *dependent* of `mem::size_of::()`. Both operations include one -//! `memcpy(T)` in their successful path. +//! `memcpy(T)` in their successful path. //! - The optimization level is indicated in parentheses. //! - The numbers reported correspond to the successful path (i.e. `Some` is returned by `dequeue` -//! and `Ok` is returned by `enqueue`). +//! and `Ok` is returned by `enqueue`). //! //! # Portability //! diff --git a/src/spsc.rs b/src/spsc.rs index 5311a7897e..471d0598d5 100644 --- a/src/spsc.rs +++ b/src/spsc.rs @@ -92,10 +92,10 @@ //! //! - All execution times are in clock cycles. 1 clock cycle = 125 ns. //! - Execution time is *dependent* of `mem::size_of::()`. Both operations include one -//! `memcpy(T)` in their successful path. +//! `memcpy(T)` in their successful path. //! - The optimization level is indicated in the first row. //! - The numbers reported correspond to the successful path (i.e. `Some` is returned by `dequeue` -//! and `Ok` is returned by `enqueue`). +//! and `Ok` is returned by `enqueue`). use core::{borrow::Borrow, cell::UnsafeCell, fmt, hash, mem::MaybeUninit, ptr}; diff --git a/src/string/mod.rs b/src/string/mod.rs index d88dbf0fd0..44c9c1559b 100644 --- a/src/string/mod.rs +++ b/src/string/mod.rs @@ -852,9 +852,9 @@ pub fn format(args: Arguments<'_>) -> Result, fmt::Err /// There are two possible error cases. Both return the unit type [`core::fmt::Error`]. /// /// - In case the formatting exceeds the string's capacity. This error does not exist in -/// the standard library as the string would just grow. +/// the standard library as the string would just grow. /// - If a formatting trait implementation returns an error. The standard library panics -/// in this case. +/// in this case. /// /// # Examples /// @@ -1102,7 +1102,7 @@ mod tests { match s.pop() { Some(c) => { assert_eq!(s.len(), 1); - assert_eq!(c, '\u{0301}'); // accute accent of e + assert_eq!(c, '\u{0301}'); // acute accent of e } None => panic!(), };