aherbert commented on code in PR #492:
URL:
https://github.com/apache/commons-collections/pull/492#discussion_r1616409493
##########
src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java:
##########
@@ -235,9 +234,12 @@ default boolean merge(final Hasher hasher) {
*
* <p>This method will return {@code true} if the filter is valid after
the operation.</p>
*
- * <p>Note: If indices that are returned multiple times should be
incremented multiple times convert the IndexExtractor
- * to a CellExtractor and add that.</p>
- *
+ * <p>Notes:</p>
+ * <ul>
+ * <li>If indices that are returned multiple times should be incremented
multiple times convert the IndexExtractor
+ * to a CellExtractor and add that.</li>
+ * <li>Implementations should throw {@code IllegalArgumentException} on
and no other exception on bad input.</li>
Review Comment:
Is there an extra `on` here after the `IllegalArgumentException`?
##########
src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java:
##########
@@ -56,20 +56,21 @@
*
* <li>Extractor - The Extractors are {@code FunctionalInterfaces} that
are conceptually iterators on a {@code BitMap}, an {@code Index}, or a
* collection of {@code Cell}s, with an early termination switch.
Extractors have
- * names like {@code BitMapExtractor} or {@code IndexExtractor} and have
a {@code processXs} methods that take a
+ * names like {@code BitMapExtractor} or {@code IndexExtractor} and have a
{@code processXs} methods that take a
* {@code Predicate<X>} argument (e.g. {@code
processBitMaps(LongPredicate)} or {@code processIndicies(IntPredicate)}).
* That predicate is expected to process each of the Xs in turn and return
{@code true} if the processing should continue
* or {@code false} to stop it. </li>
* </ul>
*
- * <p>There is an obvious association between the BitMap and the Index in that
if bit 5 is enabled in the BitMap than the index must contain the index 5.</p>
+ * <p>There is an obvious association between the BitMap and the Index in that
if bit 5 is enabled in the BitMap than the indices must contain the
Review Comment:
This still does not address what you are referring to with the noun `Index`.
We do not have an `Index` object and do not refer to this elsewhere in the
code. Can we replace `Index` with `indices`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
