Fix "an" to "a" before RingMap and RingSet

src/inner/entry.rs

@@ -23,7 +23,7 @@ impl<'a, K, V> Entry<'a, K, V> {
     }
 }
 
-/// A view into an occupied entry in an [`RingMap`][crate::RingMap].
+/// A view into an occupied entry in a [`RingMap`][crate::RingMap].
 /// It is part of the [`Entry`] enum.
 pub struct OccupiedEntry<'a, K, V> {
     map: &'a mut Core<K, V>,
@@ -252,7 +252,7 @@ impl<'a, K, V> From<IndexedEntry<'a, K, V>> for OccupiedEntry<'a, K, V> {
     }
 }
 
-/// A view into a vacant entry in an [`RingMap`][crate::RingMap].
+/// A view into a vacant entry in a [`RingMap`][crate::RingMap].
 /// It is part of the [`Entry`] enum.
 pub struct VacantEntry<'a, K, V> {
     map: &'a mut Core<K, V>,

src/macros.rs

@@ -1,4 +1,4 @@
-/// Create an [`RingMap`][crate::RingMap] from a list of key-value pairs
+/// Create a [`RingMap`][crate::RingMap] from a list of key-value pairs
 /// and a [`BuildHasherDefault`][core::hash::BuildHasherDefault]-wrapped custom hasher.
 ///
 /// ## Example
@@ -38,7 +38,7 @@ macro_rules! ringmap_with_default {
 #[cfg(feature = "std")]
 #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 #[macro_export]
-/// Create an [`RingMap`][crate::RingMap] from a list of key-value pairs
+/// Create a [`RingMap`][crate::RingMap] from a list of key-value pairs
 ///
 /// ## Example
 ///
@@ -72,7 +72,7 @@ macro_rules! ringmap {
     };
 }
 
-/// Create an [`RingSet`][crate::RingSet] from a list of values
+/// Create a [`RingSet`][crate::RingSet] from a list of values
 /// and a [`BuildHasherDefault`][core::hash::BuildHasherDefault]-wrapped custom hasher.
 ///
 /// ## Example
@@ -112,7 +112,7 @@ macro_rules! ringset_with_default {
 #[cfg(feature = "std")]
 #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 #[macro_export]
-/// Create an [`RingSet`][crate::RingSet] from a list of values
+/// Create a [`RingSet`][crate::RingSet] from a list of values
 ///
 /// ## Example
 ///

src/map.rs

@@ -1883,7 +1883,7 @@ where
     K: Hash + Eq,
     S: BuildHasher + Default,
 {
-    /// Create an `RingMap` from the sequence of key-value pairs in the
+    /// Create a `RingMap` from the sequence of key-value pairs in the
     /// iterable.
     ///
     /// `from_iter` uses the same logic as `extend`. See

src/map/entry.rs

@@ -2,7 +2,7 @@ use super::{Bucket, Core};
 use crate::inner::entry::{OccupiedEntry, VacantEntry};
 use core::{fmt, mem};
 
-/// Entry for an existing key-value pair in an [`RingMap`][crate::RingMap]
+/// Entry for an existing key-value pair in a [`RingMap`][crate::RingMap]
 /// or a vacant location to insert one.
 pub enum Entry<'a, K, V> {
     /// Existing slot with equivalent key.
@@ -237,7 +237,7 @@ impl<K: fmt::Debug, V> fmt::Debug for VacantEntry<'_, K, V> {
     }
 }
 
-/// A view into an occupied entry in an [`RingMap`][crate::RingMap] obtained by index.
+/// A view into an occupied entry in a [`RingMap`][crate::RingMap] obtained by index.
 ///
 /// This `struct` is created from the [`get_index_entry`][crate::RingMap::get_index_entry] method.
 pub struct IndexedEntry<'a, K, V> {

src/map/iter.rs

@@ -294,7 +294,7 @@ impl<K, V> Default for BucketsMut<'_, K, V> {
     }
 }
 
-/// An iterator over the entries of an [`RingMap`].
+/// An iterator over the entries of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::iter`] method.
 /// See its documentation for more.
@@ -357,7 +357,7 @@ impl<K, V> Default for Iter<'_, K, V> {
     }
 }
 
-/// A mutable iterator over the entries of an [`RingMap`].
+/// A mutable iterator over the entries of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::iter_mut`] method.
 /// See its documentation for more.
@@ -412,7 +412,7 @@ impl<K, V> Default for IterMut<'_, K, V> {
     }
 }
 
-/// A mutable iterator over the entries of an [`RingMap`].
+/// A mutable iterator over the entries of a [`RingMap`].
 ///
 /// This `struct` is created by the [`MutableKeys::iter_mut2`][super::MutableKeys::iter_mut2] method.
 /// See its documentation for more.
@@ -461,7 +461,7 @@ impl<K, V> Default for IterMut2<'_, K, V> {
     }
 }
 
-/// An owning iterator over the entries of an [`RingMap`].
+/// An owning iterator over the entries of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::into_iter`] method
 /// (provided by the [`IntoIterator`] trait). See its documentation for more.
@@ -513,7 +513,7 @@ impl<K, V> Default for IntoIter<K, V> {
     }
 }
 
-/// A draining iterator over the entries of an [`RingMap`].
+/// A draining iterator over the entries of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::drain`] method.
 /// See its documentation for more.
@@ -554,7 +554,7 @@ impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for Drain<'_, K, V> {
     }
 }
 
-/// An iterator over the keys of an [`RingMap`].
+/// An iterator over the keys of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::keys`] method.
 /// See its documentation for more.
@@ -691,7 +691,7 @@ impl<K, V> Index<usize> for Keys<'_, K, V> {
     }
 }
 
-/// An owning iterator over the keys of an [`RingMap`].
+/// An owning iterator over the keys of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::into_keys`] method.
 /// See its documentation for more.
@@ -742,7 +742,7 @@ impl<K, V> Default for IntoKeys<K, V> {
     }
 }
 
-/// An iterator over the values of an [`RingMap`].
+/// An iterator over the values of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::values`] method.
 /// See its documentation for more.
@@ -805,7 +805,7 @@ impl<K, V> Default for Values<'_, K, V> {
     }
 }
 
-/// A mutable iterator over the values of an [`RingMap`].
+/// A mutable iterator over the values of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::values_mut`] method.
 /// See its documentation for more.
@@ -860,7 +860,7 @@ impl<K, V> Default for ValuesMut<'_, K, V> {
     }
 }
 
-/// An owning iterator over the values of an [`RingMap`].
+/// An owning iterator over the values of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::into_values`] method.
 /// See its documentation for more.

src/map/raw_entry_v1.rs

@@ -168,7 +168,7 @@ impl<K, V, S> RawEntryApiV1<K, V, S> for RingMap<K, V, S> {
     }
 }
 
-/// A builder for computing where in an [`RingMap`] a key-value pair would be stored.
+/// A builder for computing where in a [`RingMap`] a key-value pair would be stored.
 ///
 /// This `struct` is created by the [`RingMap::raw_entry_v1`] method, provided by the
 /// [`RawEntryApiV1`] trait. See its documentation for more.
@@ -233,7 +233,7 @@ impl<'a, K, V, S> RawEntryBuilder<'a, K, V, S> {
     }
 }
 
-/// A builder for computing where in an [`RingMap`] a key-value pair would be stored.
+/// A builder for computing where in a [`RingMap`] a key-value pair would be stored.
 ///
 /// This `struct` is created by the [`RingMap::raw_entry_mut_v1`] method, provided by the
 /// [`RawEntryApiV1`] trait. See its documentation for more.
@@ -358,7 +358,7 @@ impl<'a, K, V, S> RawEntryMut<'a, K, V, S> {
     }
 }
 
-/// A raw view into an occupied entry in an [`RingMap`].
+/// A raw view into an occupied entry in a [`RingMap`].
 /// It is part of the [`RawEntryMut`] enum.
 pub struct RawOccupiedEntryMut<'a, K, V, S> {
     inner: OccupiedEntry<'a, K, V>,
@@ -551,7 +551,7 @@ impl<'a, K, V, S> RawOccupiedEntryMut<'a, K, V, S> {
     }
 }
 
-/// A view into a vacant raw entry in an [`RingMap`].
+/// A view into a vacant raw entry in a [`RingMap`].
 /// It is part of the [`RawEntryMut`] enum.
 pub struct RawVacantEntryMut<'a, K, V, S> {
     map: &'a mut Core<K, V>,

src/map/serde_seq.rs

@@ -1,4 +1,4 @@
-//! Functions to serialize and deserialize an [`RingMap`] as an ordered sequence.
+//! Functions to serialize and deserialize a [`RingMap`] as an ordered sequence.
 //!
 //! The default `serde` implementation serializes `RingMap` as a normal map,
 //! but there is no guarantee that serialization formats will preserve the order
@@ -60,7 +60,7 @@ where
     }
 }
 
-/// Serializes an [`RingMap`] as an ordered sequence.
+/// Serializes a [`RingMap`] as an ordered sequence.
 ///
 /// This function may be used in a field attribute for deriving [`Serialize`]:
 ///
@@ -113,7 +113,7 @@ where
     }
 }
 
-/// Deserializes an [`RingMap`] from an ordered sequence.
+/// Deserializes a [`RingMap`] from an ordered sequence.
 ///
 /// This function may be used in a field attribute for deriving [`Deserialize`]:
 ///

src/map/slice.rs

@@ -9,7 +9,7 @@ use core::fmt;
 use core::hash::{Hash, Hasher};
 use core::ops::{self, Bound, Index, IndexMut, RangeBounds};
 
-/// A dynamically-sized slice of key-value pairs in an [`RingMap`][super::RingMap].
+/// A dynamically-sized slice of key-value pairs in a [`RingMap`][super::RingMap].
 ///
 /// This supports indexed operations much like a `[(K, V)]` slice,
 /// but not any hashed operations on the map keys.

src/rayon/map.rs

@@ -49,7 +49,7 @@ where
     }
 }
 
-/// A parallel owning iterator over the entries of an [`RingMap`].
+/// A parallel owning iterator over the entries of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::into_par_iter`] method
 /// (provided by rayon's [`IntoParallelIterator`] trait). See its documentation for more.
@@ -175,7 +175,7 @@ where
     }
 }
 
-/// A parallel iterator over the entries of an [`RingMap`].
+/// A parallel iterator over the entries of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::par_iter`] method
 /// (provided by rayon's [`IntoParallelRefIterator`] trait). See its documentation for more.
@@ -305,7 +305,7 @@ where
     }
 }
 
-/// A parallel mutable iterator over the entries of an [`RingMap`].
+/// A parallel mutable iterator over the entries of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::par_iter_mut`] method
 /// (provided by rayon's [`IntoParallelRefMutIterator`] trait). See its documentation for more.
@@ -347,7 +347,7 @@ where
     }
 }
 
-/// A parallel draining iterator over the entries of an [`RingMap`].
+/// A parallel draining iterator over the entries of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::par_drain`] method
 /// (provided by rayon's [`ParallelDrainRange`] trait). See its documentation for more.
@@ -444,7 +444,7 @@ where
     }
 }
 
-/// A parallel iterator over the keys of an [`RingMap`].
+/// A parallel iterator over the keys of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::par_keys`] method.
 /// See its documentation for more.
@@ -477,7 +477,7 @@ impl<K: Sync, V: Sync> IndexedParallelIterator for ParKeys<'_, K, V> {
     indexed_parallel_iterator_methods!(Bucket::key_ref);
 }
 
-/// A parallel iterator over the values of an [`RingMap`].
+/// A parallel iterator over the values of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::par_values`] method.
 /// See its documentation for more.
@@ -658,7 +658,7 @@ where
     }
 }
 
-/// A parallel mutable iterator over the values of an [`RingMap`].
+/// A parallel mutable iterator over the values of a [`RingMap`].
 ///
 /// This `struct` is created by the [`RingMap::par_values_mut`] method.
 /// See its documentation for more.

src/rayon/set.rs

@@ -49,7 +49,7 @@ where
     }
 }
 
-/// A parallel owning iterator over the items of an [`RingSet`].
+/// A parallel owning iterator over the items of a [`RingSet`].
 ///
 /// This `struct` is created by the [`RingSet::into_par_iter`] method
 /// (provided by rayon's [`IntoParallelIterator`] trait). See its documentation for more.
@@ -102,7 +102,7 @@ where
     }
 }
 
-/// A parallel iterator over the items of an [`RingSet`].
+/// A parallel iterator over the items of a [`RingSet`].
 ///
 /// This `struct` is created by the [`RingSet::par_iter`] method
 /// (provided by rayon's [`IntoParallelRefIterator`] trait). See its documentation for more.
@@ -151,7 +151,7 @@ where
     }
 }
 
-/// A parallel draining iterator over the items of an [`RingSet`].
+/// A parallel draining iterator over the items of a [`RingSet`].
 ///
 /// This `struct` is created by the [`RingSet::par_drain`] method
 /// (provided by rayon's [`ParallelDrainRange`] trait). See its documentation for more.

src/set/iter.rs

@@ -28,7 +28,7 @@ impl<T, S> IntoIterator for RingSet<T, S> {
     }
 }
 
-/// An iterator over the items of an [`RingSet`].
+/// An iterator over the items of a [`RingSet`].
 ///
 /// This `struct` is created by the [`RingSet::iter`] method.
 /// See its documentation for more.
@@ -90,7 +90,7 @@ impl<T> Default for Iter<'_, T> {
     }
 }
 
-/// An owning iterator over the items of an [`RingSet`].
+/// An owning iterator over the items of a [`RingSet`].
 ///
 /// This `struct` is created by the [`RingSet::into_iter`] method
 /// (provided by the [`IntoIterator`] trait). See its documentation for more.
@@ -142,7 +142,7 @@ impl<T> Default for IntoIter<T> {
     }
 }
 
-/// A draining iterator over the items of an [`RingSet`].
+/// A draining iterator over the items of a [`RingSet`].
 ///
 /// This `struct` is created by the [`RingSet::drain`] method.
 /// See its documentation for more.

src/set/slice.rs

@@ -8,7 +8,7 @@ use core::fmt;
 use core::hash::{Hash, Hasher};
 use core::ops::{self, Bound, Index, RangeBounds};
 
-/// A dynamically-sized slice of values in an [`RingSet`][super::RingSet].
+/// A dynamically-sized slice of values in a [`RingSet`][super::RingSet].
 ///
 /// This supports indexed operations much like a `[T]` slice,
 /// but not any hashed operations on the values.