eclipse-collections
eclipse-collections copied to clipboard
eclipse
Improved Documentation for the Predicate Interface
Description:
- The current documentation for the Predicate interface in Eclipse Collections contained inaccuracies and could benefit from improvements. This pull request aims to enhance the clarity and accuracy of the Predicate interface documentation.
Changes Made:
- Revised the description of the Predicate interface to provide a more accurate and informative definition.
- Removed the specific mention of lambdas or closures to avoid potential confusion.
- Ensured consistency in terminology and formatting.
- Added a brief explanation of the purpose of Predicate and its usage.
Context:
- The Predicate interface is a fundamental component of Eclipse Collections, and accurate documentation is essential for users to understand its role and use it effectively.
Testing:
- I have reviewed and tested the changes to ensure they accurately reflect the intended improvements in the documentation.
Screenshots:
Request for Review:
-
I kindly request a review of these documentation improvements. Your feedback and suggestions for further enhancements are highly appreciated. @sullis @brunoborges
-
Thank you for your attention to this contribution!
Thank you very much. Here are my remarks:
- 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)"
- This changes multiples files in .idea/, which I suppose is unintentional.
Predicatecan 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.- The last sentence should end with a full stop (".").
By the way, I don't think including a screenshot is necessary in this case.
Thank you for your remarks @Chealer I will surely try to improvise again in the documentation part.