more explicit warnings for roxygen comments

Author: lorenzwalthert

R/transform-files.R

@@ -353,8 +353,9 @@ can_verify_roundtrip <- function(transformers) {
 #'
 #' If scope was set to "line_breaks" or lower (compare [tidyverse_style()]),
 #' we can compare the expression before and after styling and return an error if
-#' it is not the same. Note that this method ignores comments and no
-#' verification can be conducted if tokens are in the styling scope.
+#' it is not the same. Note that this method ignores roxygen code examples and
+#' comments and no verification can be conducted if tokens are in the styling
+#' scope.
 #' @inheritParams expressions_are_identical
 #' @importFrom rlang abort
 #' @examples

R/ui-styling.R

@@ -36,11 +36,12 @@ NULL
 #' The following section describes when and how styling is guaranteed to
 #' yield correct code.
 #'
-#' If tokens are to be styled (as specified with the `scope` argument), no tokens
-#' are changed and the abstract syntax tree (AST) should not change.
+#' If tokens are not in the styling scope (as specified with the `scope`
+#' argument), no tokens are changed and the abstract syntax tree (AST) should
+#' not change.
 #' Hence, it is possible to validate the styling by comparing whether the parsed
 #' expression before and after styling have the same AST.
-#' This comparison omits comments. styler compares
+#' This comparison omits roxygen code examples and comments. styler throws an
 #' error if the AST has changed through styling.
 #'
 #' Note that if tokens are to be styled, such a comparison is not conducted because

inst/WORDLIST

@@ -51,6 +51,7 @@ EOLs
 eq
 EQ
 eval
+examplesIf
 expr
 expr EQ
 fileext