Skip to content

Swap to roxygen2 v8.0.0#1185

Merged
jgabry merged 1 commit intomasterfrom
roxygen-v8
May 4, 2026
Merged

Swap to roxygen2 v8.0.0#1185
jgabry merged 1 commit intomasterfrom
roxygen-v8

Conversation

@VisruthSK
Copy link
Copy Markdown
Member

@VisruthSK VisruthSK commented May 3, 2026

Submission Checklist

  • Run unit tests
  • Declare copyright holder and agree to license (see below)

Summary

Migrate to latest Roxygen2 version and did a quick redoc.

Copyright and Licensing

Please list the copyright holder for the work you are submitting
(this will be you or your assignee, such as a university or company):

Visruth Srimath Kandali

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

@VisruthSK
Copy link
Copy Markdown
Member Author

VisruthSK commented May 3, 2026

Ok I looked closer into how we're documenting things and actually using R6 documentation is a much bigger hurdle than I thought. Will not be trying to swap to R6 docs in this PR--don't know if there's a massive benefit to changing either.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.21%. Comparing base (48b825d) to head (75e2504).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1185   +/-   ##
=======================================
  Coverage   91.21%   91.21%           
=======================================
  Files          15       15           
  Lines        6121     6121           
=======================================
  Hits         5583     5583           
  Misses        538      538           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@VisruthSK VisruthSK marked this pull request as ready for review May 3, 2026 19:49
@VisruthSK VisruthSK requested a review from jgabry May 3, 2026 19:49
@jgabry
Copy link
Copy Markdown
Member

jgabry commented May 4, 2026

Yeah because of the severe limitations of R6 roxygen documentation when we first created cmdstanr, we had to come up with a different way of doing the doc. I had tried using the roxygen R6 support at the time and it just wasn't good enough to make useful documentation. I haven't looked too closely into the new R6 doc functionality in roxygen2 yet, but just because I knew it would be a pain to update.

Copy link
Copy Markdown
Member

@jgabry jgabry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good, I just reran the one failing windows run.

@jgabry jgabry merged commit 73f0d4c into master May 4, 2026
24 of 25 checks passed
@jgabry jgabry deleted the roxygen-v8 branch May 4, 2026 09:05
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