From 31a68def9a31ac63071d95889de5e0fef8c9d4d3 Mon Sep 17 00:00:00 2001 From: Christian Poveda Date: Mon, 24 Mar 2025 11:28:02 -0500 Subject: [PATCH] Fix `clippy::too_long_first_doc_paragraph` warnings --- src/histbuf.rs | 3 ++- src/lib.rs | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/histbuf.rs b/src/histbuf.rs index cf152db7..3ce9aa55 100644 --- a/src/histbuf.rs +++ b/src/histbuf.rs @@ -587,7 +587,8 @@ pub struct OldestOrderedInner<'a, T, S: HistBufStorage + ?Sized> { } /// Double ended iterator on the underlying buffer ordered from the oldest data -/// to the newest +/// to the newest. +/// /// This type exists for backwards compatibility. It is always better to convert it to an [`OldestOrderedView`] with [`into_view`](OldestOrdered::into_view) pub type OldestOrdered<'a, T, const N: usize> = OldestOrderedInner<'a, T, OwnedHistBufStorage>; diff --git a/src/lib.rs b/src/lib.rs index 47532973..26f73bbc 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -140,7 +140,7 @@ ), feature(integer_atomics) )] -#![warn(clippy::use_self)] +#![warn(clippy::use_self, clippy::too_long_first_doc_paragraph)] pub use binary_heap::BinaryHeap; pub use deque::Deque;