Skip to content

Update roxygen2 to 8.1.0 - #475

Merged
florence-bockting merged 5 commits into
masterfrom
update-roxygen2-8.0.0
Nov 9, 2026
Merged

florence-bockting merged 5 commits into
masterfrom
update-roxygen2-8.0.0

Conversation

@florence-bockting

@florence-bockting florence-bockting commented Nov 5, 2026 •

Copy link
Copy Markdown
Collaborator

Description

We might want to update the documentation generation of roxygen2 to v8.0.0.
I simply moved on and created now a PR for this without first making an Issue. I hope that's okay for this change.

Changes

  • DESCRIPTION: roxygen2 8.1.0 replaces RoxygenNote: 7.3.3 with Config/roxygen2/version: 8.010.
  • man/*.Rd (42 files): all links now use one style, e.g. \link[=f]{f()} instead of \link{f}(). The rendered help does not change.
  • NAMESPACE: multiple imports per package are now grouped together.

Checks

  • R CMD check --as-cran (local, vignettes skipped): 0 errors, 0 warnings.

AI assistance

This PR used LLM assistance.

Copyright and Licensing

Copyright holder: Aalto University

By submitting this pull request, the copyright holder is agreeing to
license the submitted work under the following licenses:

Code: BSD 3-clause (https://opensource.org/licenses/BSD-3-Clause)
Documentation: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/)

Regenerate documentation with roxygen2 8.0.0. Only generated files change:
- DESCRIPTION: RoxygenNote is replaced by Config/roxygen2/version
- man/*.Rd: new link style and author list in posterior-package.Rd
@florence-bockting
florence-bockting marked this pull request as draft November 5, 2026 11:21
matrixOps exists only in R >= 4.3, so .onLoad() registers the method.
@exportS3Method NULL stops the warning and adds nothing to NAMESPACE.
@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

This is how benchmark results would change (along with a 95% confidence interval in relative change) if dfae519 is merged into master:

  • ✔️as_draws_array: 93ms -> 92.1ms [-2.4%, +0.5%]
  • ✔️as_draws_df: 30.5ms -> 30.5ms [-1.14%, +1.26%]
  • ✔️as_draws_list: 166ms -> 163ms [-4.28%, +1.08%]
  • ✔️as_draws_matrix: 24.5ms -> 24.1ms [-5.42%, +2.45%]
  • ✔️as_draws_rvars: 73.1ms -> 75.4ms [-3.54%, +9.88%]
  • ✔️summarise_draws_100_variables: 593ms -> 594ms [-0.58%, +1.11%]
  • ✔️summarise_draws_10_variables: 65.8ms -> 66.3ms [-0.24%, +1.78%]
    Further explanation regarding interpretation and methodology can be found in the documentation.

@VisruthSK

Copy link
Copy Markdown
Member

Happened to see this and bumped to 8.1.0, hope you don't mind.

@VisruthSK VisruthSK changed the title Update roxygen2 to 8.0.0 Update roxygen2 to 8.1.0 Nov 5, 2026
@florence-bockting

florence-bockting commented Nov 5, 2026 •

Copy link
Copy Markdown
Collaborator Author

Happened to see this and bumped to 8.1.0, hope you don't mind.

Ah okay, that works as well. Thanks. My main thought was making it consistent with loo. But perhaps we can then simply update roxygen also in loo

@VisruthSK

Copy link
Copy Markdown
Member

Just opened a PR in loo too: stan-dev/loo#418!

@jgabry

jgabry commented Nov 5, 2026

Copy link
Copy Markdown
Member

Just opened a PR in loo too: stan-dev/loo#418!

Thanks, merged!

@florence-bockting
florence-bockting marked this pull request as ready for review November 6, 2026 08:42
@florence-bockting

Copy link
Copy Markdown
Collaborator Author

@VisruthSK, I just added you here for the review as you basically looked already at it and I don't want to merge without approval.

@VisruthSK

Copy link
Copy Markdown
Member

Lgtm, everything's green. Didn't read the exact Rdoc changes but I haven't seen any issues in any other packages/for 8.1.0 on the whole so I think its good to go. The DESC and NAMESPACE changes both seem good too, essentially all reformatting.

@VisruthSK VisruthSK mentioned this pull request Nov 7, 2026
@florence-bockting
florence-bockting merged commit 8c64efe into master Nov 9, 2026
7 of 8 checks passed
@VisruthSK
VisruthSK deleted the update-roxygen2-8.0.0 branch November 9, 2026 11:31
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.

3 participants