uptake / pkgnet

R package for analyzing other R packages via graph representations of their dependencies
https://uptake.github.io/pkgnet/
Other
155 stars 37 forks source link

Docs Update for Roxygen2 R6 Support #323

Closed bburns632 closed 6 months ago

bburns632 commented 6 months ago

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.

To see docs & website today (before merge):

To see versions with this PR's changes:

bburns632 commented 6 months ago

Note, no CI failures due to docs. #322 will resolve remaining present CI test failures.