Skip to content

Commit 85156c3

Browse files
committed
Better comment the narrowDeps parameter
1 parent cff0209 commit 85156c3

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

core/src/main/scala/org/apache/spark/rdd/CoGroupedRDD.scala

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,12 @@ private[spark] case class NarrowCoGroupSplitDep(
4949
}
5050

5151
/**
52-
* Stores information about the narrow dependencies used by a CoGroupedRdd. narrowDeps maps to
53-
* the dependencies variable in the parent RDD: for each one to one dependency in dependencies,
54-
* narrowDeps has a NarrowCoGroupSplitDep (describing the partition for that dependency) at the
55-
* corresponding index.
52+
* Stores information about the narrow dependencies used by a CoGroupedRdd.
53+
*
54+
* @param narrowDeps maps to the dependencies variable in the parent RDD: for each one to one
55+
* dependency in dependencies, narrowDeps has a NarrowCoGroupSplitDep (describing
56+
* the partition for that dependency) at the corresponding index. The size of
57+
* narrowDeps should always be equal to the number of parents.
5658
*/
5759
private[spark] class CoGroupPartition(
5860
idx: Int, val narrowDeps: Array[Option[NarrowCoGroupSplitDep]])

0 commit comments

Comments
 (0)