[GitHub] spark pull request #18003: [SparkR] Fix bad examples in DataFrame methods an...

[felixcheung <gi...@git.apache.org>]

Github user felixcheung commented on a diff in the pull request:

    https://github.com/apache/spark/pull/18003#discussion_r116853922
  
    --- Diff: R/pkg/R/functions.R ---
    @@ -54,7 +54,8 @@ setMethod("lit", signature("ANY"),
     #' @name abs
     #' @family normal_funcs
     #' @export
    -#' @examples \dontrun{abs(df$c)}
    +#' @examples
    +#' \dontrun{abs(df$c)}
    --- End diff --
    
    I'm actually not sure about this change - if the example is simple and is single line, I think they can go on the same line as `@example` tag.
    More importantly though, I don't think majority of SQL function examples like this is usable or useful actually, and would rather have multi-line "real" example



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

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