GitHub user HyukjinKwon opened a pull request:

    https://github.com/apache/spark/pull/21020

    [MINOR][DOCS] Fix R documentation generation instruction for roxygen2

    ## 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 855eb5bf77f..159fca61e06 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.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/HyukjinKwon/spark minor-r-doc

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/spark/pull/21020.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #21020
    
----
commit a0bba18ef9a19774e1965867241f56fb0508c579
Author: hyukjinkwon <gurwls223@...>
Date:   2018-04-10T04:44:33Z

    Fix R documentation generation instruction for roxygen2

----


---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

Reply via email to