doc

StateOfTheR · Apr 18, 2020 · c6ff105 · c6ff105
1 parent 84caa83
commit c6ff105
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 3 deletions.
diff --git a/R/data.R b/R/data.R
@@ -5,4 +5,6 @@
 #'   \item{(Sepal/Petal).(Length/Width)}{Numeric}
 #'   \item{Species}{Factor}
 #' }
+#' @examples
+#' irishead
 "irishead"
diff --git a/R/joke.R b/R/joke.R
@@ -3,6 +3,8 @@
 #' @return The joke
 #' @export
 #' @importFrom dadjoke groan
+#' @examples
+#' joke()
 joke <- function(){
   groan()
 }
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -31,9 +31,14 @@ navbar:
 
 reference:
 - title: Operations
-  desc: Basic operatuions
+  desc: Basic operations
   contents:
   - '`add`'
-- title: Date
+  - '`add_cpp`'
+- title: Display stuff
   contents:
   - '`print_date`'
+  - '`joke`'
+- title: Data
+  contents:
+  - '`irishead`'
diff --git a/man/irishead.Rd b/man/irishead.Rd
diff --git a/man/joke.Rd b/man/joke.Rd
diff --git a/vignettes/example.Rmd b/vignettes/example.Rmd
@@ -34,4 +34,4 @@ add_cpp(3, 4)
 microbenchmark(add(100, 1000), add_cpp(100, 1000))
 ```
 
-The Rcpp code is 3 to 4 times slower than the base R code!
+The Rcpp code is much slower than the base R code!