[MINOR][DOCS] Fix R documentation generation instruction for roxygen2 #21020
Conversation
|
cc @felixcheung could you take a look when you are available? |
|
Test build #89087 has finished for PR 21020 at commit
|
felixcheung
left a comment
felixcheung
left a comment
There was a problem hiding this comment.
thats fine but I thought Jenkins is running 6.0.1? or maybe only on some boxes
docs/README.md
Outdated
| (Note: If you are on a system with both Ruby 1.9 and Ruby 2.0 you may need to replace gem with gem2.0) | ||
| Note: If you are on a system with both Ruby 1.9 and Ruby 2.0 you may need to replace gem with gem2.0. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
nit $SPARK_HOME/R/pkg/DESCRIPTION?
There was a problem hiding this comment.
Yea ... but this format was used below too - https://github.com/HyukjinKwon/spark/blob/a0bba18ef9a19774e1965867241f56fb0508c579/docs/README.md#api-docs-scaladoc-javadoc-sphinx-roxygen2-mkdocs
Let me change it to $SPARK_HOME all. I believe that's more correct.
I am not sure of the specific version but I assume it's older version .. |
|
Test build #89089 has finished for PR 21020 at commit
|
## What changes were proposed in this pull request? This PR proposes to fix `roxygen2` to `5.0.1` in `docs/README.md` for SparkR documentation generation. If I use higher version and creates the doc, it shows the diff below. Not a big deal but it bothered me. ```diff diff --git a/R/pkg/DESCRIPTION b/R/pkg/DESCRIPTION index 855eb5b..159fca6 100644 --- a/R/pkg/DESCRIPTION +++ b/R/pkg/DESCRIPTION -57,6 +57,6 Collate: 'types.R' 'utils.R' 'window.R' -RoxygenNote: 5.0.1 +RoxygenNote: 6.0.1 VignetteBuilder: knitr NeedsCompilation: no ``` ## How was this patch tested? Manually tested. I met this every time I set the new environment for Spark dev but I have kept forgetting to fix it. Author: hyukjinkwon <[email protected]> Closes #21020 from HyukjinKwon/minor-r-doc. (cherry picked from commit 87611bb) Signed-off-by: hyukjinkwon <[email protected]> Signed-off-by: hyukjinkwon <[email protected]>
|
Merged to master and branch-2.3. Thanks @felixcheung for reviewing this. |
3 participants
What changes were proposed in this pull request?
This PR proposes to fix
roxygen2to5.0.1indocs/README.mdfor SparkR documentation generation.If I use higher version and creates the doc, it shows the diff below. Not a big deal but it bothered me.
How was this patch tested?
Manually tested. I met this every time I set the new environment for Spark dev but I have kept forgetting to fix it.