From ef5801a036d17acc95786dc457993afcb6a3f703 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Renault?= Date: Tue, 1 Jun 2021 10:50:04 +0200 Subject: [PATCH] Update doc-comments for better descriptions of the functions behaviors Co-authored-by: marin --- src/bitmap/iter.rs | 10 +++++----- src/treemap/iter.rs | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/bitmap/iter.rs b/src/bitmap/iter.rs index 882a475b..c27797cb 100644 --- a/src/bitmap/iter.rs +++ b/src/bitmap/iter.rs @@ -139,12 +139,12 @@ impl Extend 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 index b11e19d8..4dd02101 100644 --- a/src/treemap/iter.rs +++ b/src/treemap/iter.rs @@ -224,8 +224,8 @@ impl Extend 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