[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
c75c29dcaa/.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 <mszymkiewicz@gmail.com>
Signed-off-by: Dongjoon Hyun <dhyun@apple.com>
This commit is contained in:
parent
c3d81fbe79
commit
66cc12944a
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
Loading…
Reference in a new issue