[
https://issues.apache.org/jira/browse/COLLECTIONS-857?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Gary D. Gregory reopened COLLECTIONS-857:
-----------------------------------------
Hi [~claude]
The file
{{src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java}}
seeds clarification:
- There is no {{Hasher.FileredIntConsumer}} type.
- There is no {{Hasher.uniqueIndices(Shape)}} method.
- There is method \{{processIndicies(IntPredicate)}) that I can find. Using an
@link would have detected this and the above.
- It is confusing (to me) to have camel-case names in the text that look like
type name ("BitMap") which in fact are not type names but are _very close_ to
class names ("BitMaps"!). So I'd really like to see these names not used. IOW,
"BitMap" -> "bit map". I've made with this change in git master.
- My above confusing is compounded by using the {{code}} style for these
non-code names! For example {{{{}@code Index{}}}}. I've also made a style
change here.
- "They are not \{@code Pair}objects". What "Pair" objects are we talking
about here? Apache Commons Lang {{Pair}} instances?
- "The Bloom filter architecture here is designed for speed of execution, so
some methods like \{@code merge}, \{@code remove}, \{@code add}, and \{@code
subtract}", where is there a {{remove()}} method? These references should be
@link references.
- "methods that take a \{\@code Predicate<X>\} argument" does not seem to match
the code. I see {{IntPredicate}} and {{LongBiPredicate}} in some APIs, so
talking about "predicate" seems better than a specific type like {{Predicate}}.
TY for all your work here! :-)
> Update documentation to match bloomfilter implementation.
> ---------------------------------------------------------
>
> Key: COLLECTIONS-857
> URL: https://issues.apache.org/jira/browse/COLLECTIONS-857
> Project: Commons Collections
> Issue Type: Bug
> Components: Bloomfilter
> Affects Versions: 4.5.0-M2
> Reporter: Claude Warren
> Assignee: Claude Warren
> Priority: Major
> Fix For: 4.5.0-M3
>
>
> Documentation for Bloom filter implementation references old class names and
> methods. Documentation should be updated to reflect changes and new
> implementations (e.g. layered Bloom filter)
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
