You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by gu...@apache.org on 2020/02/04 05:11:41 UTC
[spark] branch branch-3.0 updated: [MINOR][SPARKR][DOCS] Remove
duplicate @name tags from read.df and read.stream
This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch branch-3.0
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.0 by this push:
new c8ffaa9 [MINOR][SPARKR][DOCS] Remove duplicate @name tags from read.df and read.stream
c8ffaa9 is described below
commit c8ffaa9c2d86b1b8e807ad6f0570efcd0d7cd3d9
Author: zero323 <ms...@gmail.com>
AuthorDate: Mon Feb 3 11:09:25 2020 +0900
[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 in
https://github.com/apache/spark/blob/1adf3520e3c753e6df8dccb752e8239de682a09a/R/pkg/R/SQLContext.R#L546
and
https://github.com/apache/spark/blob/1adf3520e3c753e6df8dccb752e8239de682a09a/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 <ms...@gmail.com>
Signed-off-by: HyukjinKwon <gu...@apache.org>
---
R/pkg/R/SQLContext.R | 2 --
1 file changed, 2 deletions(-)
diff --git a/R/pkg/R/SQLContext.R b/R/pkg/R/SQLContext.R
index f48a334..c684291 100644
--- a/R/pkg/R/SQLContext.R
+++ b/R/pkg/R/SQLContext.R
@@ -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, ...) {
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org