Update doc-comments for better descriptions of the functions behaviors

Co-authored-by: marin <postma.marin@protonmail.com>
RoaringBitmap · Jun 1, 2021 · ef5801a · ef5801a
1 parent 0fe06ef
commit ef5801a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/src/bitmap/iter.rs b/src/bitmap/iter.rs
@@ -139,12 +139,12 @@ impl Extend<u32> for RoaringBitmap {
 impl RoaringBitmap {
     /// Create the set from a sorted iterator. Values must be sorted and deduplicated.
     ///
-    /// The values of the iterator must be ordered and strictly bigger than the biggest value
-    /// in the set. If a value in this iterator doesn't follow this rule it is not added
+    /// The values of the iterator must be ordered and strictly greater than the greatest value
+    /// in the set. If a value in the iterator doesn't satisfy this requirement, it is not added
     /// and the append operation is stopped.
     ///
     /// Returns `Ok` with the requested `RoaringBitmap`, `Err` with the number of elements
-    /// we tried to append before an error occurred.
+    /// that were correctly appended before failure.
     ///
     /// # Examples
     ///
@@ -167,8 +167,8 @@ impl RoaringBitmap {
 
     /// Extend the set with a sorted iterator.
     ///
-    /// The values of the iterator must be ordered and strictly bigger than the biggest value
-    /// in the set. If a value in this iterator doesn't follow this rule it is not added
+    /// The values of the iterator must be ordered and strictly greater than the greatest value
+    /// in the set. If a value in the iterator doesn't satisfy this requirement, it is not added
     /// and the append operation is stopped.
     ///
     /// Returns `Ok` with the number of elements appended to the set, `Err` with

diff --git a/src/treemap/iter.rs b/src/treemap/iter.rs
@@ -224,8 +224,8 @@ impl Extend<u64> for RoaringTreemap {
 impl RoaringTreemap {
     /// Create the set from a sorted iterator. Values must be sorted and deduplicated.
     ///
-    /// The values of the iterator must be ordered and strictly bigger than the biggest value
-    /// in the set. If a value in this iterator doesn't follow this rule it is not added
+    /// The values of the iterator must be ordered and strictly greater than the greatest value
+    /// in the set. If a value in the iterator doesn't satisfy this requirement, it is not added
     /// and the append operation is stopped.
     ///
     /// Returns `Ok` with the requested `RoaringTreemap`, `Err` with the number of elements
@@ -252,8 +252,8 @@ impl RoaringTreemap {
 
     /// Extend the set with a sorted iterator.
     ///
-    /// The values of the iterator must be ordered and strictly bigger than the biggest value
-    /// in the set. If a value in this iterator doesn't follow this rule it is not added
+    /// The values of the iterator must be ordered and strictly greater than the greatest value
+    /// in the set. If a value in the iterator doesn't satisfy this requirement, it is not added
     /// and the append operation is stopped.
     ///
     /// Returns `Ok` with the number of elements appended to the set, `Err` with