@@ -32,27 +32,10 @@ cache_clear <- function(cache_name = NULL, ask = TRUE) {
3232# ' Since we leverage `{R.cache}` to manage the cache, you can also use any
3333# ' `{R.cache}` functionality to manipulate it.
3434# '
35- # ' @section Interactive setup:
36- # ' `{styler}` by default uses caching via the `{R.cache}` package. When interacting
37- # ' with `{styler}`, you will be asked to let it create a permanent cache on your
38- # ' file system that styler will use in case it is not set already up for another
39- # ' tool that uses `{R.cache}`. We encourage users to let `{R.cache}` create a
40- # ' permanent directory for caching because, otherwise, the cache is lost at
41- # ' restart of R.
42- # '
43- # ' @section Non-interactive setup:
44- # ' In some cases, you want to avoid the interactive prompt described above. In
35+ # ' In some cases, you want to use a non-standard cache location. In
4536# ' that situation, you can set the path to the cache with the R option
4637# ' `R.cache.rootPath` or the environment variable `R_CACHE_ROOTPATH` to an
47- # ' existent path before you call the styler API. This should avoid the prompt.
48- # ' `R.cache::setCacheRootPath("/path/to/cache")` is also programmatic but will
49- # ' probably give the prompt anyways if called interactively.
50- # '
51- # ' @section Non-interactive use:
52- # ' Note that if you have never authorized `{R.cache}` to create the cache in a
53- # ' permanent directory and you use `{styler}` non-interactively, it will build the
54- # ' cache in a temporary directory. To create a permanent cache, follow the
55- # ' section 'Non-interactive setup' or 'Interactive setup' above.
38+ # ' existent path before you call the styler API.
5639# '
5740# ' @section Invalidation:
5841# ' The cache is specific to a version of styler by default, because different
@@ -67,8 +50,7 @@ cache_clear <- function(cache_name = NULL, ask = TRUE) {
6750# ' @section Using a cache for styler in CI/CD:
6851# ' If you want to set up caching in a CI/CD pipeline, we suggest to set the
6952# ' `{R.cache}` root path to a directory for which you have the cache enabled as
70- # ' described above in the section 'Non-interactive setup'. This can often be set
71- # ' in config files of CI/CD tools, e.g. see the
53+ # ' This can often be set in config files of CI/CD tools, e.g. see the
7254# ' [Travis documentation on caching](https://docs.travis-ci.com/user/caching).
7355# '
7456# ' @name caching
0 commit comments