Skip to content

Commit e69262a

Browse files
author
Davies Liu
committed
update doc string
1 parent 3293994 commit e69262a

File tree

1 file changed

+33
-7
lines changed
  • sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/trees

1 file changed

+33
-7
lines changed

sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/trees/TreeNode.scala

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -453,20 +453,46 @@ abstract class TreeNode[BaseType <: TreeNode[BaseType]] extends Product {
453453
*
454454
* For example:
455455
*
456-
* node
457-
* : +- innerChildren
458-
* +- treeChildren
456+
* WholeStageCodegen
457+
* +-- SortMergeJoin
458+
* |-- InputAdapter
459+
* | +-- Sort
460+
* +-- InputAdapter
461+
* +-- Sort
462+
*
463+
* the treeChildren of WholeStageCodegen will be Seq(Sort, Sort), it will generate a tree string
464+
* like this:
465+
*
466+
* WholeStageCodegen
467+
* : +- SortMergeJoin
468+
* : :- INPUT
469+
* : :- INPUT
470+
* :- Sort
471+
* :- Sort
459472
*/
460473
protected def treeChildren: Seq[BaseType] = children
461474

462475
/**
463476
* All the nodes that are parts of this node.
464477
*
465-
* innerChildren will be printed with one more level of indent, for example:
478+
* For example:
479+
*
480+
* WholeStageCodegen
481+
* +- SortMergeJoin
482+
* |-- InputAdapter
483+
* | +-- Sort
484+
* +-- InputAdapter
485+
* +-- Sort
486+
*
487+
* the innerChildren of WholeStageCodegen will be Seq(SortMergeJoin), it will generate a tree
488+
* string like this:
466489
*
467-
* node
468-
* : +- innerChildren
469-
* +- treeChildren
490+
* WholeStageCodegen
491+
* : +- SortMergeJoin
492+
* : :- INPUT
493+
* : :- INPUT
494+
* :- Sort
495+
* :- Sort
470496
*/
471497
protected def innerChildren: Seq[BaseType] = Nil
472498

0 commit comments

Comments
 (0)