Fix clippy::doc_markdown warnings

Author: pvdrz

src/binary_heap.rs

@@ -159,7 +159,7 @@ pub type BinaryHeapView<T, K> = BinaryHeapInner<T, K, ViewVecStorage<T>>;
 
 impl<T, K, const N: usize> BinaryHeap<T, K, N> {
     /* Constructors */
-    /// Creates an empty BinaryHeap as a $K-heap.
+    /// Creates an empty `BinaryHeap` as a $K-heap.
     ///
     /// ```
     /// use heapless::binary_heap::{BinaryHeap, Max};

src/histbuf.rs

@@ -791,7 +791,7 @@ mod tests {
         assert_eq!(x.as_slice(), [5, 2, 3, 4]);
     }
 
-    /// Test whether .as_slices() behaves as expected.
+    /// Test whether `.as_slices()` behaves as expected.
     #[test]
     fn as_slices() {
         let mut buffer: HistoryBuffer<u8, 4> = HistoryBuffer::new();
@@ -807,7 +807,7 @@ mod tests {
         extend_then_assert(b"123456", (b"34", b"56"));
     }
 
-    /// Test whether .as_slices() and .oldest_ordered() produce elements in the same order.
+    /// Test whether `.as_slices()` and `.oldest_ordered()` produce elements in the same order.
     #[test]
     fn as_slices_equals_ordered() {
         let mut buffer: HistoryBuffer<u8, 6> = HistoryBuffer::new();

src/lib.rs

@@ -110,17 +110,17 @@
     ),
     doc = "- [Object](pool::object::Object) -- objects managed by an object pool"
 )]
-//! - [BinaryHeap] -- priority queue
+//! - [`BinaryHeap`] -- priority queue
 //! - [Deque] -- double-ended queue
-//! - [HistoryBuffer] -- similar to a write-only ring buffer
-//! - [IndexMap] -- hash table
-//! - [IndexSet] -- hash set
-//! - [LinearMap]
-//! - [sorted_linked_list::SortedLinkedList]
+//! - [`HistoryBuffer`] -- similar to a write-only ring buffer
+//! - [`IndexMap`] -- hash table
+//! - [`IndexSet`] -- hash set
+//! - [`LinearMap`]
+//! - [`sorted_linked_list::SortedLinkedList`]
 //! - [String]
 //! - [Vec]
 //! - [`mpmc::Q*`](mpmc) -- multiple producer multiple consumer lock-free queue
-//! - [spsc] and [spsc::Queue] -- single producer single consumer lock-free queue
+//! - [spsc] and [`spsc::Queue`] -- single producer single consumer lock-free queue
 //!
 //! # Minimum Supported Rust Version (MSRV)
 //!
@@ -146,6 +146,7 @@
     clippy::redundant_pub_crate,
     clippy::option_if_let_else,
     clippy::ptr_as_ptr,
+    clippy::doc_markdown,
 )]
 
 pub use binary_heap::BinaryHeap;

src/mpmc.rs

@@ -142,12 +142,12 @@ pub struct MpMcQueueInner<T, S: Storage> {
 
 /// MPMC queue with a capacity for N elements
 /// N must be a power of 2
-/// The max value of N is u8::MAX - 1 if `mpmc_large` feature is not enabled.
+/// The max value of N is `u8::MAX` - 1 if `mpmc_large` feature is not enabled.
 pub type MpMcQueue<T, const N: usize> = MpMcQueueInner<T, OwnedStorage<N>>;
 
 /// MPMC queue with a capacity for N elements
 /// N must be a power of 2
-/// The max value of N is u8::MAX - 1 if `mpmc_large` feature is not enabled.
+/// The max value of N is `u8::MAX` - 1 if `mpmc_large` feature is not enabled.
 pub type MpMcQueueView<T> = MpMcQueueInner<T, ViewStorage>;
 
 impl<T, const N: usize> MpMcQueue<T, N> {

src/spsc.rs

@@ -27,7 +27,7 @@
 //! assert_eq!(rb.dequeue(), Some(0));
 //! ```
 //!
-//! - [Queue] can be [Queue::split] and then be used in Single Producer Single Consumer mode.
+//! - [Queue] can be [`Queue::split`] and then be used in Single Producer Single Consumer mode.
 //!
 //! "no alloc" applications can create a `&'static mut` reference to a `Queue` -- using a static
 //! variable -- and then `split` it: this consumes the static reference. The resulting `Consumer`

src/vec/mod.rs

@@ -619,11 +619,11 @@ impl<T, S: VecStorage<T> + ?Sized> VecInner<T, S> {
         }
     }
 
-    /// Resizes the Vec in-place so that len is equal to new_len.
+    /// Resizes the Vec in-place so that len is equal to `new_len`.
     ///
-    /// If new_len is greater than len, the Vec is extended by the
+    /// If `new_len` is greater than len, the Vec is extended by the
     /// difference, with each additional slot filled with value. If
-    /// new_len is less than len, the Vec is simply truncated.
+    /// `new_len` is less than len, the Vec is simply truncated.
     ///
     /// See also [`resize_default`](Self::resize_default).
     #[allow(clippy::result_unit_err)]