Skip to content

Commit 6682607

Browse files
committed
Update documentation for style_dir() and style_pkg()
1 parent 6b56ba4 commit 6682607

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

R/ui.R

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ NULL
66
#' Prettify R source code
77
#'
88
#' Performs various substitutions in all `.R` files in a package
9-
#' (code and tests).
9+
#' (code and tests). One can also (optionally) style `.Rmd` and/or
10+
#' `.Rnw` files (vignettes and readme) by changing the `filetype` argument.
1011
#' Carefully examine the results after running this function!
1112
#'
1213
#' @param pkg Path to a (subdirectory of an) R package.
@@ -146,7 +147,8 @@ style_text <- function(text,
146147

147148
#' Prettify arbitrary R code
148149
#'
149-
#' Performs various substitutions in all `.R` files in a directory.
150+
#' Performs various substitutions in all `.R`, `.Rmd` and/or `.Rnw` files
151+
#' in a directory (by default only `.R` files are styled - see `filetype` argument).
150152
#' Carefully examine the results after running this function!
151153
#' @param path Path to a directory with files to transform.
152154
#' @param recursive A logical value indicating whether or not files in subdirectories

man/style_dir.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/style_pkg.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)