From a4061ffb9286c1e3d7345b4cecd0d93a59ccebcc Mon Sep 17 00:00:00 2001 From: ripytide Date: Fri, 31 Mar 2023 17:06:25 +0100 Subject: [PATCH] uniformity in docs language --- src/range_bounds_map.rs | 12 ++++++------ src/range_bounds_set.rs | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/range_bounds_map.rs b/src/range_bounds_map.rs index 47b7ccb..e2de9fe 100644 --- a/src/range_bounds_map.rs +++ b/src/range_bounds_map.rs @@ -333,7 +333,7 @@ where /// Adds a new (`RangeBounds`, `Value`) pair to the map without /// modifying other entries. /// - /// If the new `RangeBounds` overlaps one or more `RangeBounds` + /// If the given `RangeBounds` overlaps one or more `RangeBounds` /// already in the map rather than just touching, then an /// [`OverlapError`] is returned and the map is not updated. /// @@ -401,7 +401,7 @@ where } /// Returns an iterator over every (`RangeBounds`, `Value`) pair - /// in the map which overlap the given `range_bounds` in + /// in the map which overlap the given `RangeBounds` in /// ascending order. /// /// # Examples @@ -614,7 +614,7 @@ where } /// Removes every (`RangeBounds`, `Value`) pair in the map which - /// overlaps the given `range_bounds` and returns them in + /// overlaps the given `RangeBounds` and returns them in /// an iterator. /// /// # Examples @@ -1025,7 +1025,7 @@ where /// If successful then a reference to the newly inserted /// `RangeBounds` is returned. /// - /// If the new `RangeBounds` overlaps one or more `RangeBounds` + /// If the given `RangeBounds` overlaps one or more `RangeBounds` /// already in the map rather than just touching, then an /// [`OverlapError`] is returned and the map is not updated. /// `RangeBounds` is returned. @@ -1333,7 +1333,7 @@ where /// If the remaining `RangeBounds` left after the cut are not able /// to be created with the [`TryFromBounds`] trait then a /// [`TryFromBoundsError`] will be returned. - /// + /// /// # Examples /// ``` /// use range_bounds_map::RangeBoundsMap; @@ -1531,7 +1531,7 @@ where /// Similar to [`RangeBoundsMap::overlapping()`] except the /// `(Bound, Bound)`s returned in the iterator have been - /// trimmed/cut by the given `range_bounds`. + /// trimmed/cut by the given `RangeBounds`. /// /// This is sort of the analogue to the AND function between a /// `RangeBounds` AND a [`RangeBoundsMap`]. diff --git a/src/range_bounds_set.rs b/src/range_bounds_set.rs index f57d309..f549571 100644 --- a/src/range_bounds_set.rs +++ b/src/range_bounds_set.rs @@ -177,7 +177,7 @@ where /// Adds a new `RangeBounds` to the set without modifying other /// `RangeBounds` in the set. /// - /// If the new `RangeBounds` overlaps one or more `RangeBounds` + /// If the given `RangeBounds` overlaps one or more `RangeBounds` /// already in the set rather than just touching, then an /// [`OverlapError`] is returned and the set is not updated. /// @@ -228,7 +228,7 @@ where } /// Returns an iterator over every `RangeBounds` in the set which - /// overlap the given `range_bounds` in ascending order. + /// overlap the given `RangeBounds` in ascending order. /// /// # Examples /// ``` @@ -316,7 +316,7 @@ where } /// Removes every `RangeBounds` in the set which overlaps the - /// given `range_bounds` and returns them in an iterator. + /// given `RangeBounds` and returns them in an iterator. /// /// # Examples /// ``` @@ -534,7 +534,7 @@ where /// If successful then a reference to the newly inserted /// `RangeBounds` is returned. /// - /// If the new `RangeBounds` overlaps one or more `RangeBounds` + /// If the given `RangeBounds` overlaps one or more `RangeBounds` /// already in the set rather than just touching, then an /// [`OverlapError`] is returned and the set is not updated. /// @@ -689,7 +689,7 @@ where } /// Adds a new `RangeBounds` to the set and overwrites any other - /// `RangeBounds` that overlap the new `RangeBounds`. + /// `RangeBounds` that overlap the given `RangeBounds`. /// /// This is equivalent to using [`RangeBoundsSet::cut()`] /// followed by [`RangeBoundsSet::insert_strict()`]. @@ -837,7 +837,7 @@ where /// Similar to [`RangeBoundsSet::overlapping()`] except the /// `(Bound, Bound)`s returned in the iterator have been - /// trimmed/cut by the given `range_bounds`. + /// trimmed/cut by the given `RangeBounds`. /// /// This is sort of the analogue to the AND function between a /// `RangeBounds` AND a [`RangeBoundsSet`].