Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved Documentation for the Predicate Interface #1497

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

BrijeshPatra
Copy link

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:

Screenshot (493)

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!

@Chealer
Copy link

Chealer commented Sep 5, 2023

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
Copy link
Author

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

@Chealer
Copy link

Chealer commented Sep 6, 2023

Great
It is my pleasure @BrijeshPatra

Copy link
Contributor

@donraab donraab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @BrijeshPatra, thank you for your contribution. Your PR includes many changes to files unrelated to the Predicate javadoc changes. Please undo these changes, amend your commit, and rebase and squash your two commits down to one. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants