[GitHub] seancxmao commented on a change in pull request #23273: [MINOR][DOC] Fix comments of ConvertToLocalRelation rule

[GitBox <gi...@apache.org>]

seancxmao commented on a change in pull request #23273: [MINOR][DOC] Fix comments of ConvertToLocalRelation rule
URL: https://github.com/apache/spark/pull/23273#discussion_r240886207
 
 

 ##########
 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:
   @srowen Sorry, I found that the links just do not work for scaladoc, though they works in IDE like Intellij IDEA. I should have generated the docs to see if there's any problem.
   
   I have changed `[[...]]` to backticks in a new commit.
   
   Also, I have some findings:
   * Because `org/apache/spark/sql/catalyst` is excluded for doc generation, I include catalyst in `SparkBuild.scala` and run `build/sbt unidoc`, there are many errors/warnings, should we fix these problems? Seems simple but many places.
   * As for `[[...]]`, fully qualified class name should be used if a link points to a class in another package. If the link points to a class in the same package, package prefix could be omitted.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org