diff options
| author | Kai Jiang <jiangkai@gmail.com> | 2016-06-05 13:03:02 -0700 |
|---|---|---|
| committer | Shivaram Venkataraman <shivaram@cs.berkeley.edu> | 2016-06-05 13:03:02 -0700 |
| commit | 8a9110510c9e4cbbcb0dede62cb4b9dd1c6bc8cc (patch) | |
| tree | 3f7e067f6c13781a54d7a3cb65c6f9fe9f7b8906 /R/DOCUMENTATION.md | |
| parent | 372fa61f511843f53498b9e843a84cfdd76fa2b2 (diff) | |
| download | spark-8a9110510c9e4cbbcb0dede62cb4b9dd1c6bc8cc.tar.gz spark-8a9110510c9e4cbbcb0dede62cb4b9dd1c6bc8cc.tar.bz2 spark-8a9110510c9e4cbbcb0dede62cb4b9dd1c6bc8cc.zip | |
[MINOR][R][DOC] Fix R documentation generation instruction.
## What changes were proposed in this pull request?
changes in R/README.md
- Make step of generating SparkR document more clear.
- link R/DOCUMENTATION.md from R/README.md
- turn on some code syntax highlight in R/README.md
## How was this patch tested?
local test
Author: Kai Jiang <jiangkai@gmail.com>
Closes #13488 from vectorijk/R-Readme.
Diffstat (limited to 'R/DOCUMENTATION.md')
| -rw-r--r-- | R/DOCUMENTATION.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/R/DOCUMENTATION.md b/R/DOCUMENTATION.md index 931d01549b..7314a1fccc 100644 --- a/R/DOCUMENTATION.md +++ b/R/DOCUMENTATION.md @@ -1,12 +1,12 @@ # SparkR Documentation -SparkR documentation is generated using in-source comments annotated using using -`roxygen2`. After making changes to the documentation, to generate man pages, +SparkR documentation is generated by using in-source comments and annotated by using +[`roxygen2`](https://cran.r-project.org/web/packages/roxygen2/index.html). After making changes to the documentation and generating man pages, you can run the following from an R console in the SparkR home directory - - library(devtools) - devtools::document(pkg="./pkg", roclets=c("rd")) - +```R +library(devtools) +devtools::document(pkg="./pkg", roclets=c("rd")) +``` You can verify if your changes are good by running R CMD check pkg/ |