Docs Update for Roxygen2 R6 Support #323
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note, no CI failures due to docs. #322 will resolve remaining present CI test failures. |
jameslamb
approved these changes
Apr 27, 2024
There was a problem hiding this comment.
I didn't check this for correctness... I'm not familiar with {roxygen2}'s patterns for documenting {R6} classes.
Just quickly skimmed for grammar, and approving to say "yes I totally support just fully overhauling the docs to work the way that {roxygen2} now wants them to".
Thanks for doing this!
| #' @importFrom R6 R6Class | ||
| #' @export | ||
| Three <- R6::R6Class( | ||
| # R6 classes don't need classname to match generator name | ||
| classname = "HardlyThree", | ||
| inherit = Two, | ||
| public = list( | ||
| #' @description | ||
| #' Print poem thrice |
modern R6 doc standards for roxygen and pkgdown link to node measures page instead of inherit section default reports detail
bburns632
force-pushed
the
just_docs_update
branch
from
813a399 to
685f3cc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We wrote our docs before
Roxygen2added native support forR6objects. 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
R6objects to be in line with currentRoxygen2support (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); ?pkgnetTo see versions with this PR's changes:
devtools::install_local("."); library(pkgnet); ?pkgnetpkgdown::build_site(".")