New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
3 participants
@HyukjinKwon
Member

HyukjinKwon commented Apr 10, 2018

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 --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.

@HyukjinKwon

This comment has been minimized.

Show comment
Hide comment
@HyukjinKwon

HyukjinKwon Apr 10, 2018

Member

cc @felixcheung could you take a look when you are available?

Member

HyukjinKwon commented Apr 10, 2018

cc @felixcheung could you take a look when you are available?

@SparkQA

This comment has been minimized.

Show comment
Hide comment
@SparkQA

SparkQA Apr 10, 2018

Test build #89087 has finished for PR 21020 at commit a0bba18.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

SparkQA commented Apr 10, 2018

Test build #89087 has finished for PR 21020 at commit a0bba18.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.
@felixcheung

thats fine but I thought Jenkins is running 6.0.1? or maybe only on some boxes

Show outdated Hide outdated docs/README.md Outdated
@HyukjinKwon

This comment has been minimized.

Show comment
Hide comment
@HyukjinKwon

HyukjinKwon Apr 10, 2018

Member

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 ..

Member

HyukjinKwon commented Apr 10, 2018

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 ..

@SparkQA

This comment has been minimized.

Show comment
Hide comment
@SparkQA

SparkQA Apr 10, 2018

Test build #89089 has finished for PR 21020 at commit 86b3b28.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

SparkQA commented Apr 10, 2018

Test build #89089 has finished for PR 21020 at commit 86b3b28.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

asfgit pushed a commit that referenced this pull request Apr 11, 2018

[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.

Author: hyukjinkwon <gurwls223@apache.org>

Closes #21020 from HyukjinKwon/minor-r-doc.

(cherry picked from commit 87611bb)

Signed-off-by: hyukjinkwon <gurwls223@apache.org>

Signed-off-by: hyukjinkwon <gurwls223@apache.org>
@HyukjinKwon

This comment has been minimized.

Show comment
Hide comment
@HyukjinKwon

HyukjinKwon Apr 11, 2018

Member

Merged to master and branch-2.3.

Thanks @felixcheung for reviewing this.

Member

HyukjinKwon commented Apr 11, 2018

Merged to master and branch-2.3.

Thanks @felixcheung for reviewing this.

@asfgit asfgit closed this in 87611bb Apr 11, 2018

pepinoflo added a commit to pepinoflo/spark that referenced this pull request May 15, 2018

[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.

Author: hyukjinkwon <gurwls223@apache.org>

Closes apache#21020 from HyukjinKwon/minor-r-doc.

@HyukjinKwon HyukjinKwon deleted the HyukjinKwon:minor-r-doc branch Oct 16, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment