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 2016/09/03 04:12:02 UTC
spark git commit: [SPARKR][MINOR] Fix docs for sparkR.session and
count
Repository: spark
Updated Branches:
refs/heads/master e6132a6cf -> d2fde6b72
[SPARKR][MINOR] Fix docs for sparkR.session and count
## What changes were proposed in this pull request?
This PR tries to add some more explanation to `sparkR.session`. It also modifies doc for `count` so when grouped in one doc, the description doesn't confuse users.
## How was this patch tested?
Manual test.
Author: Junyang Qian <ju...@databricks.com>
Closes #14942 from junyangq/fixSparkRSessionDoc.
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/d2fde6b7
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/d2fde6b7
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/d2fde6b7
Branch: refs/heads/master
Commit: d2fde6b72c4aede2e7edb4a7e6653fb1e7b19924
Parents: e6132a6
Author: Junyang Qian <ju...@databricks.com>
Authored: Fri Sep 2 21:11:57 2016 -0700
Committer: Shivaram Venkataraman <sh...@cs.berkeley.edu>
Committed: Fri Sep 2 21:11:57 2016 -0700
----------------------------------------------------------------------
R/pkg/R/functions.R | 3 ++-
R/pkg/R/group.R | 2 +-
R/pkg/R/sparkR.R | 6 ++++--
3 files changed, 7 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/spark/blob/d2fde6b7/R/pkg/R/functions.R
----------------------------------------------------------------------
diff --git a/R/pkg/R/functions.R b/R/pkg/R/functions.R
index 369b1d0..ceedbe7 100644
--- a/R/pkg/R/functions.R
+++ b/R/pkg/R/functions.R
@@ -444,7 +444,8 @@ setMethod("cosh",
#' Returns the number of items in a group
#'
-#' Returns the number of items in a group. This is a column aggregate function.
+#' This can be used as a column aggregate function with \code{Column} as input,
+#' and returns the number of items in a group.
#'
#' @rdname count
#' @name count
http://git-wip-us.apache.org/repos/asf/spark/blob/d2fde6b7/R/pkg/R/group.R
----------------------------------------------------------------------
diff --git a/R/pkg/R/group.R b/R/pkg/R/group.R
index e3479ef..17f5283 100644
--- a/R/pkg/R/group.R
+++ b/R/pkg/R/group.R
@@ -57,7 +57,7 @@ setMethod("show", "GroupedData",
#' Count
#'
-#' Count the number of rows for each group.
+#' Count the number of rows for each group when we have \code{GroupedData} input.
#' The resulting SparkDataFrame will also contain the grouping columns.
#'
#' @return A SparkDataFrame.
http://git-wip-us.apache.org/repos/asf/spark/blob/d2fde6b7/R/pkg/R/sparkR.R
----------------------------------------------------------------------
diff --git a/R/pkg/R/sparkR.R b/R/pkg/R/sparkR.R
index de53b0b..15afe01 100644
--- a/R/pkg/R/sparkR.R
+++ b/R/pkg/R/sparkR.R
@@ -314,8 +314,10 @@ sparkRHive.init <- function(jsc = NULL) {
#' Get the existing SparkSession or initialize a new SparkSession.
#'
-#' Additional Spark properties can be set (...), and these named parameters take priority over
-#' over values in master, appName, named lists of sparkConfig.
+#' SparkSession is the entry point into SparkR. \code{sparkR.session} gets the existing
+#' SparkSession or initializes a new SparkSession.
+#' Additional Spark properties can be set in \code{...}, and these named parameters take priority
+#' over values in \code{master}, \code{appName}, named lists of \code{sparkConfig}.
#'
#' For details on how to initialize and use SparkR, refer to SparkR programming guide at
#' \url{http://spark.apache.org/docs/latest/sparkr.html#starting-up-sparksession}.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org