[
https://issues.apache.org/jira/browse/CALCITE-6698?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17899464#comment-17899464
]
Stamatis Zampetakis commented on CALCITE-6698:
----------------------------------------------
I updated the summary and description of this JIRA/PR based on the discussion
above. Currently the PR, just adds Javadoc and some explicit tests for these
methods.
> Add Javadoc to PartiallyOrderedSet#getNonChildren and getNonParents to
> clarify their behavior
> ---------------------------------------------------------------------------------------------
>
> Key: CALCITE-6698
> URL: https://issues.apache.org/jira/browse/CALCITE-6698
> Project: Calcite
> Issue Type: Task
> Components: core
> Reporter: Stamatis Zampetakis
> Assignee: Stamatis Zampetakis
> Priority: Major
> Labels: pull-request-available
> Fix For: 1.39.0
>
>
> Than naming of the methods in conjunction with the following Javadoc comment
> {code:java}
> * <p>In addition to the usual set methods, there are methods to determine the
> * immediate parents and children of an element in the set, and method to find
> * all elements which have no parents or no children (i.e. "root" and "leaf"
> * elements).
> {code}
> led me to the *wrong* conclusion that they do the following:
> * {{getNonChildren}} return all elements which have no children (leafs)
> * {{getNonParents}} return all elements which have no parents (roots)
> while they do the opposite.
> The name is subject to different interpretations so to avoid similar
> confusion in the future we should add some explicit documentation to the
> methods.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
