Skip to content

Suggest a fix if a mismatch in roxygen2 versions is found during check #2636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hadley merged 3 commits into from
Jan 21, 2026
+20 −16
Merged

Suggest a fix if a mismatch in roxygen2 versions is found during check #2636

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
faaa646
Suggest a fix if a mismatch in roxygen2 versions is found during check.
mcol Jan 9, 2026
18fa228
Merged origin/main into mcol-issue_2624
hadley Jan 21, 2026
eb654bc
Tweak error; refactor; improve test
hadley Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion R/check.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ can_document <- function(pkg) {
cli::cat_rule("Documenting", col = "red", line = 2)
cli::cli_inform(c(
i = "Installed roxygen2 version ({installed}) doesn't match required ({required})",
x = "{.fun check} will not re-document this package"
x = "{.fun check} will not re-document this package, use {.fun document} to update the {.file DESCRIPTION} file"
Copy link
Copy Markdown
Member

@jennybc jennybc Jan 13, 2026

Choose a reason for hiding this comment

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

I'm worried this is a case of being overly specific with the recommendation.

For example, for me, this is much more often a case of me running dev roxygen2. In which case, I usually want to downgrade the installed roxygen2 version to the released version.

I'm not totally convinced that more words are going to help. It's possible that seeing this a couple times, feeling puzzled, then figuring out how you want to proceed is sort of a package development rite of passage?

But we can discuss a different wording.

Copy link
Copy Markdown
Member

@hadley hadley Jan 21, 2026

Choose a reason for hiding this comment

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

I tweaked the error to fit in more with our usual style (i.e. make it more of a hint) and did some refactoring to make it easier to test.

))
FALSE
} else {
Expand Down