eclipse / eclipse-collections

Eclipse Collections is a collections framework for Java with optimized data structures and a rich, functional and fluent API.
https://eclipse.dev/collections/
2.42k stars 604 forks source link

Improved Documentation for the Predicate Interface #1497

Open BrijeshPatra opened 1 year ago

BrijeshPatra commented 1 year ago

Description:

Changes Made:

Context:

Testing:

Screenshots:

Screenshot (493)

Request for Review:

Chealer commented 1 year ago

Thank you very much. Here are my remarks:

  1. if "filtering and "discriminating" are used as synonyms, I would recommend to substitute "for filtering or discriminating" with either:
    • "for filtering (discriminating)"
    • "for filtering/discriminating"
    • "for filtering (also called discriminating)"
  2. This changes multiples files in .idea/, which I suppose is unintentional.
  3. Predicate can treat objects, but it can treat any type, including primitives. This problem is basically pre-existing, but it would be better to talk about "elements" than objects.
  4. The last sentence should end with a full stop (".").

By the way, I don't think including a screenshot is necessary in this case.

BrijeshPatra commented 1 year ago

Thank you for your remarks @Chealer I will surely try to improvise again in the documentation part.

Chealer commented 1 year ago

Great It is my pleasure @BrijeshPatra