Skip to content

Commit bb21706

Browse files
committed
Delegate to the lintr docs for details like the cache location
1 parent 647db33 commit bb21706

File tree

2 files changed

+15
-21
lines changed

2 files changed

+15
-21
lines changed

R/lint.R

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
#' Lint all source files in a package.
1+
#' Lint all source files in a package
22
#'
33
#' The default linters correspond to the style guide at
4-
#' <https://style.tidyverse.org/>, however it is possible to
5-
#' override any or all of them using the `linters` parameter.
4+
#' <https://style.tidyverse.org/>, however it is possible to override any or all
5+
#' of them using the `linters` parameter.
6+
#'
67
#' @template devtools
7-
#' @param cache store the lint results so repeated lints of the same content
8-
#' use the previous results.
9-
#' @param ... additional arguments passed to [lintr::lint_package()]
8+
#' @param cache Store the lint results so repeated lints of the same content use
9+
#' the previous results. Consult the lintr package to learn more about its
10+
#' caching behaviour.
11+
#' @param ... Additional arguments passed to [lintr::lint_package()].
1012
#' @seealso [lintr::lint_package()], [lintr::lint()]
11-
#' @details
12-
#' The lintr cache is by default stored in `~/.R/lintr_cache/` (this can
13-
#' be configured by setting `options(lintr.cache_directory)`). It can be
14-
#' cleared by calling [lintr::clear_cache()].
1513
#' @export
1614
lint <- function(pkg = ".", cache = TRUE, ...) {
1715
rlang::check_installed("lintr")

man/lint.Rd

Lines changed: 7 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)