Migrate documentation to roxygen2 7.3.3 #601
Merged
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.
tl;dr This PR makes minor edits to the documentation of the non-exported function
hupdate()to unblock migration to roxgyen2 7.3.3xref: Merck/simtrial#351
Background
When I update to roxygen2 7.3.3 and document the package, I receive the following messages:
I'm not certain exactly what caused this change between roxygen2 7.3.3 and 7.3.2, but my guess is that it was PR r-lib/roxygen2#1633 to "Resolve markdown links to external packages". It isn't worth investigating further because these messages are about the documentation for the internal function
hupdate()which has the tag@noRd. Thus I fixed it by converting the links to code syntax.Alternative considered
Since both
h1()andhupdate()already have nice documentation written for them, my initial plan was to simply remove the@noRdtags. This didn't work though because they are not exported toNAMESPACE, and thus their examples fail. FromR CMD check:The next consideration would be to export them, but they were explicitly un-exported for {gsDesign2} 1.1.0 (#253, #261), so I abandoned this approach.
gsDesign2/NEWS.md
Line 207 in fe4d2dc