Github user felixcheung commented on a diff in the pull request:
https://github.com/apache/spark/pull/11336#discussion_r82907977
--- Diff: R/pkg/R/DataFrame.R ---
@@ -1168,12 +1179,14 @@ setMethod("take",
#' Head
#'
-#' Return the first \code{num} rows of a SparkDataFrame as a R data.frame.
If \code{num} is not
-#' specified, then head() returns the first 6 rows as with R data.frame.
+#' Return the first elements of a dataset. If \code{x} is a
SparkDataFrame, its first
+#' rows will be returned as a data.frame. If the dataset is a
\code{Column}, its first
+#' elements will be returned as a vector. The number of elements to be
returned
+#' is given by parameter \code{num}. Default value for \code{num} is 6.
#'
-#' @param x a SparkDataFrame.
-#' @param num the number of rows to return. Default is 6.
-#' @return A data.frame.
+#' @param x A SparkDataFrame or Column
--- End diff --
for something like this the convention we have is to add the @param in
generics.R - you can see other examples there
---
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 [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
