[GitHub] [spark] huonw commented on a change in pull request #24414: [SPARK-22044][SQL] Add `cost` and `codegen` arguments to `explain`

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

huonw commented on a change in pull request #24414: [SPARK-22044][SQL] Add `cost` and `codegen` arguments to `explain`
URL: https://github.com/apache/spark/pull/24414#discussion_r277955434
 
 

 ##########
 File path: R/pkg/R/DataFrame.R
 ##########
 @@ -136,7 +136,15 @@ setMethod("schema",
 
 #' Explain
 #'
-#' Print the logical and physical Catalyst plans to the console for debugging.
+#' Print the Catalyst plans to the console for debugging.
+#'
+#' With no (or, all FALSE) options, this prints the physical
+#' plan. The options are mutually exclusive: at most one can be
+#' true.
+#'
+#' @param extended print the logical plans as well as the physical plans
+#' @param codegen print the generated code for whole-stage codegen
+#' @param cost print the optimized logical plan with operator costs
 
 Review comment:
   Hm, I'm not sure what to do about that. It looks like most of the other functions in that file use either `...` or a specific parameter list, without `@param` documentation, but `explain` uses `...` with `@param` documentation for both a specific parameter and the `...`. Could you give some advice?
   
   (Also, I don't see any failures on AppVeyor? It seems to just stop mid-log.)

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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