Added example to help file for preview_rd().

wviechtb · wviechtb · commit 240815a83841 · 2020-06-25T09:33:43.000+02:00
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: mathjaxr
-Version: 1.0-0
-Date: 2020-06-05
+Version: 1.0-1
+Date: 2020-06-25
 Title: Using 'Mathjax' in Rd Files
 Authors@R: person(given = "Wolfgang", family = "Viechtbauer", role = c("aut","cre"), email = "wvb@wvbauer.com", comment = c(ORCID = "0000-0003-3463-4063"))
 Description: Provides 'MathJax' and macros to enable its use within Rd files for rendering equations in the HTML help files.
diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# mathjaxr 1.0-0 (2020-06-05)
+# mathjaxr 1.0-1 (2020-06-25)
 
 * added `\mjteqn` and `\mjtdeqn` macros (triple-argument versions)
 
diff --git a/man/preview_rd.Rd b/man/preview_rd.Rd
@@ -27,4 +27,10 @@ preview_rd(Rdfile, view = TRUE, type = "html", verbose = FALSE)
 \author{
    Wolfgang Viechtbauer \email{wvb@wvbauer.com} \url{http://www.wvbauer.com/}
 }
+\examples{
+\dontrun{
+setwd("/path/to/root/of/package")
+preview_rd("someRdfile")
+}
+}
 \keyword{utilities}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# mathjaxr 1.0-0 (2020-06-05)`
	`1`	`+# mathjaxr 1.0-1 (2020-06-25)`
`2`	`2`
`3`	`3`	* added `\mjteqn` and `\mjtdeqn` macros (triple-argument versions)
`4`	`4`