Skip to content

more informative error message on nested dont statements in roxygen code examples #1275

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
merged 2 commits into from
Oct 12, 2025
Merged

more informative error message on nested dont statements in roxygen code examples #1275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2ba561
more informative error message on nested dont statements in roxygen c…
lorenzwalthert Oct 12, 2025
269ec40
Merge branch 'main' into dev-roxygen-nested
lorenzwalthert Oct 12, 2025
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
11 changes: 11 additions & 0 deletions R/roxygen-examples-find.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,17 @@ find_dont_seqs <- function(bare) {
find_dont_closings <- function(bare, dont_openings) {
opening <- cumsum(bare == "{")
closing <- cumsum(bare == "}")
if (sum(closing) == 0L) {
rlang::abort(paste0(
"Failed to find closing braces for a \\dont* statement in a roxygen ",
"code example. This is most likely caused by nested \\donttest, ",
"\\dontrun or \\dontshow statement. These are not supported with ",
"{styler}, not even when {styler} is turned off for these lines as per ",
"the documentation at ",
"https://styler.r-lib.org/articles/styler.html#ignoring-certain-lines. ",
"See also GitHub issue https://github.com/r-lib/styler/issues/498."
))
}
diff <- opening - closing
level_dont <- diff[dont_openings]
match_closing <- intersect(
Expand Down
13 changes: 13 additions & 0 deletions tests/testthat/test-roxygen-examples-parse.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ test_that("donts can be parsed", {
)
})

test_that("Nested dont* statements return informative error message", {
expect_error(
style_roxygen_code_example_one(
c(
"#' @examples", "#' # styler: off", "#' \\donttest{", "#' \\dontshow{",
"#' 1+1", "#' }", "#' }", "#' # styler: on"
),
transformers = tidyverse_style(scope = "spaces"), base_indention = 2L
),
regexp = "nested \\\\donttest"
)
})

test_that("braces examples can be parsed", {
expect_equal(
parse_roxygen(
Expand Down
Loading