Regenerate documentation with roxygen2 8.0.0 - #75
Merged
Conversation
Running devtools::document() picks up two real improvements beyond the version bump: roxygen2 8.0.0 correctly converts markdown "- item" bullet lists inside @PARAM docs into \itemize{} blocks (7.3.1 left them as literal, un-rendered "- item" text in the help pages), and the two roxygen cross-reference fixes from #74 are now reflected in the generated man pages. The remaining changes are link-markup style updates (\code{\link{x}()} -> \code{\link[=x]{x()}}) with no content changes.
This file contains hidden or 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
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.
Summary
Ran
devtools::document()(roxygen2 8.0.0, up from theRoxygenNote: 7.3.1pin — the R 4.6/devtools toolchain set up while investigating the CI issues in #73 doesn't have 7.3.1 available). Beyond the version bump itself, this picks up two real improvements:- itembullet lists inside@param/@returndocs as literal, un-rendered text in the generated.Rdfiles (e.g.nmr_normalize'smethodargument documentation). roxygen2 8.0.0 correctly converts these into\itemize{}blocks, so they'll actually render as bulleted lists in?nmr_normalizeand similar help pages.The remaining bulk of the diff is
\code{\link{x}()}→\code{\link[=x]{x()}}link-markup style changes across all 68 man pages — no content changes, just how roxygen2 8.0.0 formats@family/@seealsocross-references.DESCRIPTIONnow recordsConfig/roxygen2/version: 8.0.0instead ofRoxygenNote: 7.3.1(roxygen2 8.0's own naming convention for this field).Test plan
devtools::document()runs with no warningsR CMD INSTALL .succeeds, including vignette buildinglibrary(AlpsNMR)loads cleanlyGenerated by Claude Code