Merge pull request #290 from lorenzwalthert/master

- Adapt documentation (#290).

Author: lorenzwalthert

R/addins.R

@@ -16,7 +16,8 @@
 #' @seealso [Sys.setenv()]
 NULL
 
-#' @describeIn styler_addins Styles the active file
+#' @describeIn styler_addins Styles the active file with [tidyverse_style()] and
+#'   `strict = TRUE`.
 style_active_file <- function() {
   transformer <- make_transformer(tidyverse_style())
   context <- get_rstudio_context()
@@ -53,7 +54,8 @@ try_transform_as_r_file <- function(context, transformer) {
   ))
 }
 
-#' @describeIn styler_addins Styles the highlighted region
+#' @describeIn styler_addins Styles the highlighted selection in a `.R` or
+#'   `.Rmd` file.
 style_selection <- function() {
   context <- get_rstudio_context()
   text <- context$selection[[1]]$text

R/ui.R

@@ -121,9 +121,9 @@ prettify_any <- function(transformers, recursive, exclude_files) {
 
 }
 
-#' Style a file
+#' Style `.R` and/or `.Rmd` files
 #'
-#' Performs various substitutions in the `.R` file specified.
+#' Performs various substitutions in the files specified.
 #'   Carefully examine the results after running this function!
 #' @param path A character vector with paths to files to style.
 #' @inheritParams style_pkg

README.Rmd

@@ -51,7 +51,7 @@ style_text(ugly_code)
 
 There are a few variants of `style_text()`:
 
-* `style_file()` styles a single .R file.
+* `style_file()` styles .R and/or .Rmd files.
 * `style_dir()` styles all .R files in a directory.
 * `style_pkg()` styles the source files of an R package.
 * RStudio Addins for styling the active file, styling the current package and 

README.md

@@ -26,7 +26,7 @@ style_text(ugly_code)
 
 There are a few variants of `style_text()`:
 
--   `style_file()` styles a single .R file.
+-   `style_file()` styles .R and/or .Rmd files.
 -   `style_dir()` styles all .R files in a directory.
 -   `style_pkg()` styles the source files of an R package.
 -   RStudio Addins for styling the active file, styling the current package and styling the highlighted code region.