allow ordinary comments in roxygen comments

Author: lorenzwalthert

NEWS.md

@@ -1,8 +1,14 @@
+
 # styler 1.5.1.9000 (Development version)
 
+* Files with `.Rmarkdown` extension are now recognized as an R markdown files in `style_file()` and friends (#824).
+
 * Don't break line before comments in pipes (#822).
 
-* Files with `.Rmarkdown` extension are now recognised as an R markdown files in `style_file()` and friends (#824)
+* Ordinary comments (starting with `#`) within a roxygen code example block 
+  (starting with `#'`) are now recognized and preserved (#830).
+
+* Break the line between `%>%` and `{` inside and outside function calls (#825).
 
 # styler 1.5.1
 

R/roxygen-examples-parse.R

@@ -131,6 +131,8 @@ emulate_rd <- function(roxygen) {
       gsub("^#'(\\s|\t)*@examples(If)?(\\s|\t)*(.*)", "#' @examples \\4", roxygen),
       "x <- 1"
     )
+    roxygen <- gsub("(^#)[^']", "#' #", roxygen)
+
     text <- roxygen2::roc_proc_text(
       roxygen2::rd_roclet(),
       paste(roxygen, collapse = "\n")

R/roxygen-examples.R

@@ -25,12 +25,23 @@ style_roxygen_code_example <- function(example, transformers, base_indention) {
 style_roxygen_code_example_one <- function(example_one, transformers, base_indention) {
   bare <- parse_roxygen(example_one)
   one_dont <- split(bare$text, factor(cumsum(bare$text %in% dont_keywords())))
-  map(one_dont, style_roxygen_code_example_segment,
+  styled <- map(one_dont, style_roxygen_code_example_segment,
     transformers = transformers,
     base_indention = base_indention
   ) %>%
     flatten_chr() %>%
     add_roxygen_mask(bare$example_type)
+
+  ordinary_comment <- grep("^#[^']", example_one, value = TRUE)
+  if (length(ordinary_comment) == 0L) {
+    return(styled)
+  }
+  without_mask <- remove_roxygen_mask(styled)
+  for (idx in seq_along(ordinary_comment)) {
+    to_replace <- which(ordinary_comment[idx] == without_mask)[1]
+    styled[to_replace] <- ordinary_comment[idx]
+  }
+  styled
 }
 
 #' Style a roxygen code example segment

man/style_pkg.Rd

@@ -0,0 +1,110 @@
+#' Example
+# Random comment
+#' Roxygen
+#' @examples
+#' 1 + 1
+NULL
+
+
+#' Example
+# Random comment
+#' Roxygen
+#' @examplesIf
+#' 1 + 1
+NULL
+
+#' Example
+# Random comment
+#' Roxygen
+#' @examples
+#' 1 + 1
+# comment
+# more
+NULL
+
+#' Example
+# Random comment
+#' Roxygen
+#' @examples
+# There
+#' 1 + 1
+# comment
+# more
+NULL
+
+#' Example
+#' Random comment
+#' Roxygen
+#' @examples
+# There
+#' 1 + 1
+# comment
+# more
+NULL
+
+#' Example
+# Random comment
+#' Roxygen
+#' @examples
+# There
+#' \dontrun{
+#' 1 + 1
+#' }
+# comment
+# more
+NULL
+
+#' Example
+# Random comment
+#' Roxygen
+#' @examples
+# There
+#' \dontrun{
+#' 1 + 1
+#' } # comment
+# more
+NULL
+
+#' Example
+# Random comment
+#' Roxygen
+#' @examples
+# 'There
+#' \dontrun{
+#' 1 + 1
+#' }
+# comment
+# more
+NULL
+
+#' Example
+# Random comment
+#' Roxygen
+#' @examples
+# There
+#' \dontrun{
+# comment
+#' 1 + 1
+#' }
+# more
+NULL
+
+#' Example
+# Random comment
+#' Roxygen
+#' @examples
+# There
+#' \dontrun{
+#' call(
+# comment
+#' 1 + 1
+#' )
+#' }
+# more
+NULL
+
+# nolint start
+#' @examplesIf TRUE
+# nolint end
+#' df %>% func()
+func <- function() NULL