srowen commented on a change in pull request #23273: [MINOR][DOC] Fix comments
of ConvertToLocalRelation rule
URL: https://github.com/apache/spark/pull/23273#discussion_r241017367
##########
File path:
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/optimizer/Optimizer.scala
##########
@@ -1370,10 +1370,10 @@ object DecimalAggregates extends Rule[LogicalPlan] {
}
/**
- * Converts local operations (i.e. ones that don't require data exchange) on
LocalRelation to
- * another LocalRelation.
+ * Converts local operations (i.e. ones that don't require data exchange) on
[[LocalRelation]] to
+ * another [[LocalRelation]].
*
- * This is relatively simple as it currently handles only 2 single case:
Project and Limit.
+ * This rule currently handles 3 cases: [[Project]], [[Limit]] and [[Filter]].
Review comment:
`catalyst` isn't meant to be a public API (for our convenience, it's not all
marked private in the source). That's why it's not in the docs and yeah that's
why writing references to it won't work, as I recall.
For this comment I think it's simplest to remove it, or leave it but don't
add references, or move it to an inline comment.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
