document

Author: lorenzwalthert

R/ui-caching.R

@@ -31,9 +31,9 @@ cache_clear <- function(cache_name = NULL, ask = TRUE) {
 #' @section Setup:
 #' styler by default uses caching, via the `{R.cache}` package. You will be
 #' asked you to let it create a permanent cache on your file system that styler
-#' will use in case you have not set that up already for another tool that
-#' uses `{R.cache}`.
-#' This is needed if you want to cache across R sessions and not just within.
+#' will use in case it is not set that up already for another tool that
+#' uses `{R.cache}`. We encourage users to let `{R.cache}` create a permanent
+#' directory for caching, because otherwise, the cache is lost at restart of R.
 #'
 #' @section Non-interactive use:
 #' Note that if you have never authorized `{R.cache}` to create the cache in a

README.Rmd

@@ -43,10 +43,11 @@ You can install the package from CRAN.
 install.packages("styler")
 ```
 
-You will be prompted to decide on how to use the [caching
-feature](https://styler.r-lib.org/dev/reference/caching.html). See `?caching`
-for details, in particular when you don't use styler interactively (i.e. not
-from the R prompt or Rstudio Addin, )
+If you don't use styler interactively (i.e. not from the R prompt or Rstudio 
+Addin), make sure you authorise `{R.cache}` once to set up a permanent cache. 
+If you use it interactively, you will be asked to grant this permission once.
+See `?caching` for details.
+
 
 Or get the development version from GitHub:
 

README.md

@@ -31,10 +31,10 @@ You can install the package from CRAN.
 install.packages("styler")
 ```
 
-You will be prompted to decide on how to use the [caching
-feature](https://styler.r-lib.org/dev/reference/caching.html). See
-`?caching` for details, in particular when you don’t use styler
-interactively (i.e. not from the R prompt or Rstudio Addin, )
+If you don’t use styler interactively (i.e. not from the R prompt or
+Rstudio Addin), make sure you authorise `{R.cache}` once to set up a
+permanent cache. If you use it interactively, you will be asked to grant
+this permission once. See `?caching` for details.
 
 Or get the development version from GitHub: