Skip to content

Regenerate documentation with roxygen2 8.0.0 - #75

Merged
zeehio merged 1 commit into
develfrom
claude/alpsnmr-critical-review-jmrdcl
Jul 11, 2026
Merged

Regenerate documentation with roxygen2 8.0.0#75
zeehio merged 1 commit into
develfrom
claude/alpsnmr-critical-review-jmrdcl

Conversation

@zeehio

@zeehio zeehio commented Jul 11, 2026

Copy link
Copy Markdown
Member

Summary

Ran devtools::document() (roxygen2 8.0.0, up from the RoxygenNote: 7.3.1 pin — 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:

  • Markdown bullet lists now render correctly. roxygen2 7.3.1 left - item bullet lists inside @param/@return docs as literal, un-rendered text in the generated .Rd files (e.g. nmr_normalize's method argument documentation). roxygen2 8.0.0 correctly converts these into \itemize{} blocks, so they'll actually render as bulleted lists in ?nmr_normalize and similar help pages.
  • Picks up the Fix broken roxygen cross-references to @noRd functions #74 cross-reference fixes in the generated man pages (nothing further needed there — just confirming they're reflected).

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/@seealso cross-references.

DESCRIPTION now records Config/roxygen2/version: 8.0.0 instead of RoxygenNote: 7.3.1 (roxygen2 8.0's own naming convention for this field).

Test plan

  • devtools::document() runs with no warnings
  • R CMD INSTALL . succeeds, including vignette building
  • library(AlpsNMR) loads cleanly

Generated by Claude Code

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.
@zeehio
zeehio merged commit 4e5aca7 into devel Jul 11, 2026
2 checks passed
@zeehio
zeehio deleted the claude/alpsnmr-critical-review-jmrdcl branch July 11, 2026 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants