Merge pull request #830 from lorenzwalthert/issue-828

- Allow comments in roxygen comment blocks (#830).

Author: lorenzwalthert

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: styler
 Title: Non-Invasive Pretty Printing of R Code
-Version: 1.5.1.9000
+Version: 1.5.1.9001
 Authors@R: 
     c(person(given = "Kirill",
              family = "Müller",

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-add-remove.R

@@ -34,14 +34,30 @@ remove_roxygen_header <- function(text) {
 
 #' Add the roxygen mask to code
 #'
+#' This function compares `text` with `initial_text` to make sure a mask is only
+#' added to roxygen comments, not ordinary comments
 #' @param text Character vector with code.
+#' @param initial_text The roxygen code example to style with mask and
+#'   potentially ordinary comments.
 #' @param example_type Either 'examples' or 'examplesIf'.
 #' @keywords internal
 #' @importFrom purrr map2_chr
-add_roxygen_mask <- function(text, example_type) {
+add_roxygen_mask <- function(text, initial_text, example_type) {
   space <- ifelse(text == "", "", " ")
-  c(
+  out <- c(
     paste0("#' @", example_type, space[1], text[1]),
     map2_chr(space[-1], text[-1], ~ paste0("#'", .x, .y))
   )
+
+  ordinary_comment <- grep("^#[^']", initial_text, value = TRUE)
+  if (length(ordinary_comment) == 0L) {
+    return(out)
+  }
+  without_mask <- remove_roxygen_mask(out)
+  for (idx in seq_along(ordinary_comment)) {
+    to_replace <- which(ordinary_comment[idx] == without_mask)[1]
+    out[to_replace] <- ordinary_comment[idx]
+    without_mask[to_replace] <- NA
+  }
+  out
 }

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

@@ -30,7 +30,7 @@ style_roxygen_code_example_one <- function(example_one, transformers, base_inden
     base_indention = base_indention
   ) %>%
     flatten_chr() %>%
-    add_roxygen_mask(bare$example_type)
+    add_roxygen_mask(example_one, bare$example_type)
 }
 
 #' Style a roxygen code example segment

man/add_roxygen_mask.Rd

@@ -0,0 +1,133 @@
+#' 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
+
+
+#' Hi
+# Comment
+#' @examples
+#' 1 + 1
+# this
+# this
+#this
+# thi3
+#' c()
+NULL
+
+#' Hi
+# Comment
+#' @examples
+#' 1 + 1
+# this
+# this 
+#this
+# thi3
+#' c()
+NULL