You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by do...@apache.org on 2021/01/16 01:08:44 UTC

[spark] branch master updated: [SPARK-34132][DOCS][R] Update Roxygen version references to 7.1.1

This is an automated email from the ASF dual-hosted git repository.

dongjoon pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/master by this push:
     new 66cc129  [SPARK-34132][DOCS][R] Update Roxygen version references to 7.1.1
66cc129 is described below

commit 66cc12944a2d70562e16a57db4dc9ef187b8e59d
Author: zero323 <ms...@gmail.com>
AuthorDate: Fri Jan 15 17:08:17 2021 -0800

    [SPARK-34132][DOCS][R] Update Roxygen version references to 7.1.1
    
    ### What changes were proposed in this pull request?
    
    This PR updates `roxygen2` version reference in docs and `DESCRIPTION` file.
    
    ### Why are the changes needed?
    
    According to information provided by shaneknapp (see [this comment](https://issues.apache.org/jira/browse/SPARK-30747?focusedCommentId=17265142&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17265142) to SPARK-30747) all workers use roxygen 7.1.1.
    
    In GitHub workflow we install the latest version
    
    https://github.com/apache/spark/blob/c75c29dcaa9458a9ce0dd7a4d5fafbffb4b7f6a6/.github/workflows/build_and_test.yml#L346
    
    which [is also 7.1.1 at the moment](https://web.archive.org/web/20210115172522/https://cran.r-project.org/web/packages/roxygen2/).
    
    ### Does this PR introduce _any_ user-facing change?
    
    Docs and description mention currently used package verison.
    
    ### How was this patch tested?
    
    - `dev/lint-r`.
    - Manual check of command used in docs.
    
    Closes #31200 from zero323/ROXYGEN-VERSION-UPDATE-DOCS.
    
    Authored-by: zero323 <ms...@gmail.com>
    Signed-off-by: Dongjoon Hyun <dh...@apple.com>
---
 R/pkg/DESCRIPTION | 2 +-
 docs/README.md    | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/R/pkg/DESCRIPTION b/R/pkg/DESCRIPTION
index c141baa..37cd41f 100644
--- a/R/pkg/DESCRIPTION
+++ b/R/pkg/DESCRIPTION
@@ -59,7 +59,7 @@ Collate:
     'types.R'
     'utils.R'
     'window.R'
-RoxygenNote: 5.0.1
+RoxygenNote: 7.1.1
 VignetteBuilder: knitr
 NeedsCompilation: no
 Encoding: UTF-8
diff --git a/docs/README.md b/docs/README.md
index af51dca..0f74766 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -48,10 +48,10 @@ and install these libraries:
 
 ```sh
 $ sudo Rscript -e 'install.packages(c("knitr", "devtools", "testthat", "rmarkdown"), repos="https://cloud.r-project.org/")'
-$ sudo Rscript -e 'devtools::install_version("roxygen2", version = "5.0.1", repos="https://cloud.r-project.org/")'
+$ sudo Rscript -e 'devtools::install_version("roxygen2", version = "7.1.1", repos="https://cloud.r-project.org/")'
 ```
 
-Note: Other versions of roxygen2 might work in SparkR documentation generation but `RoxygenNote` field in `$SPARK_HOME/R/pkg/DESCRIPTION` is 5.0.1, which is updated if the version is mismatched.
+Note: Other versions of roxygen2 might work in SparkR documentation generation but `RoxygenNote` field in `$SPARK_HOME/R/pkg/DESCRIPTION` is 7.1.1, which is updated if the version is mismatched.
 
 ### API Documentation
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org