[CALCITE-6698] Add Javadoc to PartiallyOrderedSet#getNonChildren and getNonParents to clarify their behavior #4054
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
zabetak
commented
Nov 18, 2024
•
zabetak
commented
- Add Javadoc to clarify the results of each method and avoid potential misinterpretation of their name.
- Add some test cases with explicit tests for the aforementioned methods.
…hildren and getNonParents 1. Align the behavior of getNonChildren/getNonParents with: i) the class documentation; ii) the behavior of getParents/getChildren methods. 2. Add explicit Javadoc to clarify the results of its method. 3. Update and add test cases with expected results.
asolimando
reviewed
Nov 18, 2024
| PartiallyOrderedSet<Integer> poset = | ||
| new PartiallyOrderedSet<>((i, j) -> i >= j, Arrays.asList(20, 30, 40)); | ||
| printValidate(poset); | ||
| System.out.println(poset.getChildren(20)); |
There was a problem hiding this comment.
This has slipped through the cracks I guess
There was a problem hiding this comment.
Thanks for catching this. I removed those in the last commit.
|
-1 There is no bug here. You are just mistaken what 'non-parents' means. |
zabetak
added
the
discussion-in-jira
zabetak
changed the title
|
As discussed, under the ticket there is no reason to change the behavior of the methods. The scope of the PR changed to simply clarify the current behavior by adding Javadoc comments so I updated the summary and description. |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.