Skip to content

Commit 41563a9

Browse files
derive example type independently of whether nor not rd emulation is needed. Match \t anyways as although it can't be in file input, it can be in text input (and unit tests)
1 parent 380f0d7 commit 41563a9

File tree

3 files changed

+12
-23
lines changed

3 files changed

+12
-23
lines changed

R/roxygen-examples-add-remove.R

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,7 @@ remove_roxygen_mask <- function(text) {
2929
#' #' @examples c(1, 2)
3030
#' @keywords internal
3131
remove_roxygen_header <- function(text) {
32-
text <- gsub("^\\s*@examples(If\\s|\\s|$)", "", text, perl = TRUE)
33-
if (grepl("^If ", text[1])) {
34-
text[1] <- gsub("^If\\s*", "", text[1])
35-
example_type <- "examplesIf"
36-
} else {
37-
example_type <- "examples"
38-
}
39-
40-
list(
41-
text = text,
42-
example_type = example_type
43-
)
32+
gsub("^\\s*@examples(If)?(\\s|\t)*", "", text, perl = TRUE)
4433
}
4534

4635
#' Add the roxygen mask to code

R/roxygen-examples-find.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
#' @importFrom rlang seq2
88
#' @keywords internal
99
identify_start_to_stop_of_roxygen_examples_from_text <- function(text) {
10-
starts <- grep("^#'\\s*@examples(If\\s|\\s|$)", text, perl = TRUE)
10+
starts <- grep("^#'\\s*@examples(If\\s|\\s|\t|$)", text, perl = TRUE)
1111
if (length(starts) < 1L) {
1212
return(integer())
1313
}

R/roxygen-examples-parse.R

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,11 @@ roxygen_remove_extra_brace <- function(parsed) {
124124
#' `remove_roxygen_mask()` when there are no characters to escape.
125125
#' @keywords internal
126126
emulate_rd <- function(roxygen) {
127+
example_type <- gsub("^#'(\\s|\t)*@examples(If)?(\\s|\t)*(.*)", "examples\\2", roxygen[1])
127128
if (needs_rd_emulation(roxygen)) {
128-
example_type <- gsub("^#'\\s*@examples(If)?.*", "examples\\1", roxygen[1])
129-
130129
roxygen <- c(
131130
"#' Example",
132-
gsub("^#'\\s*@examples(If)?\\s*(.*)", "#' @examples \\2", roxygen),
131+
gsub("^#'(\\s|\t)*@examples(If)?(\\s|\t)*(.*)", "#' @examples \\4", roxygen),
133132
"x <- 1"
134133
)
135134
text <- roxygen2::roc_proc_text(
@@ -138,16 +137,17 @@ emulate_rd <- function(roxygen) {
138137
)[[1]]$get_section("examples") %>%
139138
as.character() %>%
140139
.[-1]
141-
list(
142-
text = c(
143-
if (grepl("^#'\\s*@examples\\s*$", roxygen[2])) "",
144-
text
145-
),
146-
example_type = example_type
140+
text <- c(
141+
if (grepl("^#'(\\s|\t)*@examples(\\s|\t)*$", roxygen[2])) "",
142+
text
147143
)
148144
} else {
149-
remove_roxygen_mask(roxygen)
145+
text <- remove_roxygen_mask(roxygen)
150146
}
147+
list(
148+
text = text,
149+
example_type = example_type
150+
)
151151
}
152152

153153
#' Check if rd emulation is required with [roxygen2::roc_proc_text()]

0 commit comments

Comments
 (0)