Skip to content

Commit 73a1df3

Browse files
committed
Remove weird Returns comments for lazy vals in DataflowGraph
1 parent 6b20fa0 commit 73a1df3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

sql/pipelines/src/main/scala/org/apache/spark/sql/pipelines/graph/DataflowGraph.scala

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ case class DataflowGraph(flows: Seq[Flow], tables: Seq[Table], views: Seq[View])
3434
extends GraphOperations
3535
with GraphValidations {
3636

37-
/** Returns a [[Output]] given its identifier */
37+
/** Map of [[Output]]s by their identifiers */
3838
lazy val output: Map[TableIdentifier, Output] = mapUnique(tables, "output")(_.identifier)
3939

4040
/**
41-
* Returns [[Flow]]s in this graph that need to get planned and potentially executed when
41+
* [[Flow]]s in this graph that need to get planned and potentially executed when
4242
* executing the graph. Flows that write to logical views are excluded.
4343
*/
4444
lazy val materializedFlows: Seq[ResolvedFlow] = {
@@ -47,14 +47,14 @@ case class DataflowGraph(flows: Seq[Flow], tables: Seq[Table], views: Seq[View])
4747
)
4848
}
4949

50-
/** Returns the identifiers of [[materializedFlows]]. */
50+
/** The identifiers of [[materializedFlows]]. */
5151
val materializedFlowIdentifiers: Set[TableIdentifier] = materializedFlows.map(_.identifier).toSet
5252

53-
/** Returns a [[Table]] given its identifier */
53+
/** Map of [[Table]]s by their identifiers */
5454
lazy val table: Map[TableIdentifier, Table] =
5555
mapUnique(tables, "table")(_.identifier)
5656

57-
/** Returns a [[Flow]] given its identifier */
57+
/** Map of [[Flow]]s by their identifier */
5858
lazy val flow: Map[TableIdentifier, Flow] = {
5959
// Better error message than using mapUnique.
6060
val flowsByIdentifier = flows.groupBy(_.identifier)
@@ -89,20 +89,20 @@ case class DataflowGraph(flows: Seq[Flow], tables: Seq[Table], views: Seq[View])
8989
flowsByIdentifier.view.mapValues(_.head).toMap
9090
}
9191

92-
/** Returns a [[View]] given its identifier */
92+
/** Map of [[View]]s by their identifiers */
9393
lazy val view: Map[TableIdentifier, View] = mapUnique(views, "view")(_.identifier)
9494

95-
/** Returns the [[PersistedView]]s of the graph */
95+
/** The [[PersistedView]]s of the graph */
9696
lazy val persistedViews: Seq[PersistedView] = views.collect {
9797
case v: PersistedView => v
9898
}
9999

100-
/** Returns all the [[Input]]s in the current DataflowGraph. */
100+
/** All the [[Input]]s in the current DataflowGraph. */
101101
lazy val inputIdentifiers: Set[TableIdentifier] = {
102102
(flows ++ tables).map(_.identifier).toSet
103103
}
104104

105-
/** Returns the [[Flow]]s that write to a given destination. */
105+
/** The [[Flow]]s that write to a given destination. */
106106
lazy val flowsTo: Map[TableIdentifier, Seq[Flow]] = flows.groupBy(_.destinationIdentifier)
107107

108108
lazy val resolvedFlows: Seq[ResolvedFlow] = {
@@ -155,7 +155,7 @@ case class DataflowGraph(flows: Seq[Flow], tables: Seq[Table], views: Seq[View])
155155
}
156156

157157
/**
158-
* Returns a map of the inferred schema of each table, computed by merging the analyzed schemas
158+
* A map of the inferred schema of each table, computed by merging the analyzed schemas
159159
* of all flows writing to that table.
160160
*/
161161
lazy val inferredSchema: Map[TableIdentifier, StructType] = {

0 commit comments

Comments
 (0)