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

Improve Javadoc for AreIn, IsIn and CollectionContains #301

Open
GCHQDeveloper314 opened this issue Nov 3, 2022 · 0 comments
Open

Improve Javadoc for AreIn, IsIn and CollectionContains #301

GCHQDeveloper314 opened this issue Nov 3, 2022 · 0 comments
Labels
tech-debt Relates to Technical Debt
Milestone

Comments

@GCHQDeveloper314
Copy link
Member

Currently the JavaDoc is quite basic for these classes in Koryphe. In particular the handling of null and empty values for functions and predicates is not explained sufficiently well.
For CollectionContains the Javadoc states that it "checks if a collection contains a provided value" and it is able to check for if a collection contains null values. The name CollectionContains explains this functionality to some extent. The situation is not so good for IsIn and AreIn. The language should be clearer with less of a fix of words with similar meanings.

@GCHQDeveloper314 GCHQDeveloper314 added this to the post-v2.0_backlog milestone Nov 3, 2022
@GCHQDeveloper314 GCHQDeveloper314 added the tech-debt Relates to Technical Debt label Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tech-debt Relates to Technical Debt
Projects
None yet
Development

No branches or pull requests

1 participant