You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by sh...@apache.org on 2015/10/21 06:40:26 UTC
spark git commit: [SPARK-11221][SPARKR] fix R doc for lit and add
examples
Repository: spark
Updated Branches:
refs/heads/master 135ade905 -> 1107bd958
[SPARK-11221][SPARKR] fix R doc for lit and add examples
Currently the documentation for `lit` is inconsistent with doc format, references "Scala symbol" and has no example. Fixing that.
shivaram
Author: felixcheung <fe...@hotmail.com>
Closes #9187 from felixcheung/rlit.
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/1107bd95
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/1107bd95
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/1107bd95
Branch: refs/heads/master
Commit: 1107bd958aefc793d6e8e369ad6268b24a0f8510
Parents: 135ade9
Author: felixcheung <fe...@hotmail.com>
Authored: Tue Oct 20 21:40:22 2015 -0700
Committer: Shivaram Venkataraman <sh...@cs.berkeley.edu>
Committed: Tue Oct 20 21:40:22 2015 -0700
----------------------------------------------------------------------
R/pkg/R/functions.R | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/spark/blob/1107bd95/R/pkg/R/functions.R
----------------------------------------------------------------------
diff --git a/R/pkg/R/functions.R b/R/pkg/R/functions.R
index a220ad8..a72fb7b 100644
--- a/R/pkg/R/functions.R
+++ b/R/pkg/R/functions.R
@@ -18,16 +18,21 @@
#' @include generics.R column.R
NULL
-#' Creates a \code{Column} of literal value.
+#' lit
#'
-#' The passed in object is returned directly if it is already a \linkS4class{Column}.
-#' If the object is a Scala Symbol, it is converted into a \linkS4class{Column} also.
-#' Otherwise, a new \linkS4class{Column} is created to represent the literal value.
+#' A new \linkS4class{Column} is created to represent the literal value.
+#' If the parameter is a \linkS4class{Column}, it is returned unchanged.
#'
#' @family normal_funcs
#' @rdname lit
#' @name lit
#' @export
+#' @examples
+#' \dontrun{
+#' lit(df$name)
+#' select(df, lit("x"))
+#' select(df, lit("2015-01-01"))
+#'}
setMethod("lit", signature("ANY"),
function(x) {
jc <- callJStatic("org.apache.spark.sql.functions",
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org