You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by HyukjinKwon <gi...@git.apache.org> on 2018/04/10 04:50:58 UTC

[GitHub] spark pull request #21020: [MINOR][DOCS] Fix R documentation generation inst...

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 <gu...@...>
Date:   2018-04-10T04:44:33Z

    Fix R documentation generation instruction for roxygen2

----


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    Test PASSed.
    Refer to this link for build results (access rights to CI server needed): 
    https://amplab.cs.berkeley.edu/jenkins//job/testing-k8s-prb-make-spark-distribution/2125/
    Test PASSed.


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by SparkQA <gi...@git.apache.org>.
Github user SparkQA commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    **[Test build #89089 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/89089/testReport)** for PR 21020 at commit [`86b3b28`](https://github.com/apache/spark/commit/86b3b2840f48fd35b390baec2ea57787c1c35535).


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by HyukjinKwon <gi...@git.apache.org>.
Github user HyukjinKwon commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    > thats fine but I thought Jenkins is running 6.0.1? or maybe only on some boxes
    
    I am not sure of the specific version but I assume it's older version ..


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    Test PASSed.
    Refer to this link for build results (access rights to CI server needed): 
    https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/89089/
    Test PASSed.


---

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


[GitHub] spark pull request #21020: [MINOR][DOCS] Fix R documentation generation inst...

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

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


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by HyukjinKwon <gi...@git.apache.org>.
Github user HyukjinKwon commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    Merged to master and branch-2.3.
    
    Thanks @felixcheung for reviewing this.


---

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


[GitHub] spark pull request #21020: [MINOR][DOCS] Fix R documentation generation inst...

Posted by felixcheung <gi...@git.apache.org>.
Github user felixcheung commented on a diff in the pull request:

    https://github.com/apache/spark/pull/21020#discussion_r180312977
  
    --- Diff: docs/README.md ---
    @@ -22,10 +22,13 @@ $ sudo gem install jekyll jekyll-redirect-from pygments.rb
     $ sudo pip install Pygments
     # Following is needed only for generating API docs
     $ sudo pip install sphinx pypandoc mkdocs
    -$ sudo Rscript -e 'install.packages(c("knitr", "devtools", "roxygen2", "testthat", "rmarkdown"), repos="http://cran.stat.ucla.edu/")'
    +$ sudo Rscript -e 'install.packages(c("knitr", "devtools", "testthat", "rmarkdown"), repos="http://cran.stat.ucla.edu/")'
    +$ sudo Rscript -e 'devtools::install_version("roxygen2", version = "5.0.1", repos="http://cran.stat.ucla.edu/")'
     ```
     
    -(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.
    --- End diff --
    
    nit `$SPARK_HOME/R/pkg/DESCRIPTION`?


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by HyukjinKwon <gi...@git.apache.org>.
Github user HyukjinKwon commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    cc @felixcheung could you take a look when you are available?


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by SparkQA <gi...@git.apache.org>.
Github user SparkQA commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    **[Test build #89087 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/89087/testReport)** for PR 21020 at commit [`a0bba18`](https://github.com/apache/spark/commit/a0bba18ef9a19774e1965867241f56fb0508c579).


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    Merged build finished. Test PASSed.


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by SparkQA <gi...@git.apache.org>.
Github user SparkQA commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    **[Test build #89087 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/89087/testReport)** for PR 21020 at commit [`a0bba18`](https://github.com/apache/spark/commit/a0bba18ef9a19774e1965867241f56fb0508c579).
     * This patch passes all tests.
     * This patch merges cleanly.
     * This patch adds no public classes.


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by SparkQA <gi...@git.apache.org>.
Github user SparkQA commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    **[Test build #89089 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/89089/testReport)** for PR 21020 at commit [`86b3b28`](https://github.com/apache/spark/commit/86b3b2840f48fd35b390baec2ea57787c1c35535).
     * This patch passes all tests.
     * This patch merges cleanly.
     * This patch adds no public classes.


---

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


[GitHub] spark pull request #21020: [MINOR][DOCS] Fix R documentation generation inst...

Posted by HyukjinKwon <gi...@git.apache.org>.
Github user HyukjinKwon commented on a diff in the pull request:

    https://github.com/apache/spark/pull/21020#discussion_r180313623
  
    --- Diff: docs/README.md ---
    @@ -22,10 +22,13 @@ $ sudo gem install jekyll jekyll-redirect-from pygments.rb
     $ sudo pip install Pygments
     # Following is needed only for generating API docs
     $ sudo pip install sphinx pypandoc mkdocs
    -$ sudo Rscript -e 'install.packages(c("knitr", "devtools", "roxygen2", "testthat", "rmarkdown"), repos="http://cran.stat.ucla.edu/")'
    +$ sudo Rscript -e 'install.packages(c("knitr", "devtools", "testthat", "rmarkdown"), repos="http://cran.stat.ucla.edu/")'
    +$ sudo Rscript -e 'devtools::install_version("roxygen2", version = "5.0.1", repos="http://cran.stat.ucla.edu/")'
     ```
     
    -(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.
    --- End diff --
    
    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.


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    Test PASSed.
    Refer to this link for build results (access rights to CI server needed): 
    https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/89087/
    Test PASSed.


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    Merged build finished. Test PASSed.


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    Test PASSed.
    Refer to this link for build results (access rights to CI server needed): 
    https://amplab.cs.berkeley.edu/jenkins//job/testing-k8s-prb-make-spark-distribution/2123/
    Test PASSed.


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    Merged build finished. Test PASSed.


---

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


[GitHub] spark issue #21020: [MINOR][DOCS] Fix R documentation generation instruction...

Posted by AmplabJenkins <gi...@git.apache.org>.
Github user AmplabJenkins commented on the issue:

    https://github.com/apache/spark/pull/21020
  
    Merged build finished. Test PASSed.


---

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