We wrote our docs before Roxygen2 added native support for R6 objects. Now, our custom docs are causing complications in testing and doc formatting, especially in R development version which does not appear to honor the list(r6=FALSE) DESCRIPTION file work around. It's time.
This PR rewrites our docs for R6 objects to be in line with current Roxygen2 support (roxygen2 v7.3.1). Documentation attempted to be kept very similar to the original.
We wrote our docs before
Roxygen2
added native support forR6
objects. Now, our custom docs are causing complications in testing and doc formatting, especially in R development version which does not appear to honor thelist(r6=FALSE)
DESCRIPTION file work around. It's time.This PR rewrites our docs for
R6
objects to be in line with currentRoxygen2
support (roxygen2 v7.3.1). Documentation attempted to be kept very similar to the original.To see docs & website today (before merge):
install.packages("pkgnet"); library(pkgnet); ?pkgnet
To see versions with this PR's changes:
devtools::install_local("."); library(pkgnet); ?pkgnet
pkgdown::build_site(".")