[MINOR][SPARKR][DOCS] Remove duplicate @name tags from read.df and read.stream
### What changes were proposed in this pull request? Remove duplicate `name` tags from `read.df` and `read.stream`. ### Why are the changes needed? These tags are already present in1adf3520e3/R/pkg/R/SQLContext.R (L546)
and1adf3520e3/R/pkg/R/SQLContext.R (L678)
for `read.df` and `read.stream` respectively. As only one `name` tag per block is allowed, this causes build warnings with recent `roxygen2` versions: ``` Warning: [/path/to/spark/R/pkg/R/SQLContext.R:559] name May only use one name per block Warning: [/path/to/spark/R/pkg/R/SQLContext.R:690] name May only use one name per block ``` ### Does this PR introduce any user-facing change? No. ### How was this patch tested? Existing tests. Closes #27437 from zero323/roxygen-warnings-names. Authored-by: zero323 <mszymkiewicz@gmail.com> Signed-off-by: HyukjinKwon <gurwls223@apache.org>
This commit is contained in:
parent
1adf3520e3
commit
fb321b666d
|
@ -556,7 +556,6 @@ tableToDF <- function(tableName) {
|
|||
#' stringSchema <- "name STRING, info MAP<STRING, DOUBLE>"
|
||||
#' df4 <- read.df(mapTypeJsonPath, "json", stringSchema, multiLine = TRUE)
|
||||
#' }
|
||||
#' @name read.df
|
||||
#' @note read.df since 1.4.0
|
||||
read.df <- function(path = NULL, source = NULL, schema = NULL, na.strings = "NA", ...) {
|
||||
if (!is.null(path) && !is.character(path)) {
|
||||
|
@ -687,7 +686,6 @@ read.jdbc <- function(url, tableName,
|
|||
#' stringSchema <- "name STRING, info MAP<STRING, DOUBLE>"
|
||||
#' df1 <- read.stream("json", path = jsonDir, schema = stringSchema, maxFilesPerTrigger = 1)
|
||||
#' }
|
||||
#' @name read.stream
|
||||
#' @note read.stream since 2.2.0
|
||||
#' @note experimental
|
||||
read.stream <- function(source = NULL, schema = NULL, ...) {
|
||||
|
|
Loading…
Reference in a new issue