From 45dca2af8b6075e8a189b98bf0b354ded2875da0 Mon Sep 17 00:00:00 2001 From: Lorenz Walthert Date: Sat, 23 Jan 2021 21:55:18 +0100 Subject: [PATCH] random roxygenize --- inst/WORDLIST | 1 + man/caching.Rd | 8 ++++---- man/save_after_styling_is_active.Rd | 13 +++++++++++++ 3 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 man/save_after_styling_is_active.Rd diff --git a/inst/WORDLIST b/inst/WORDLIST index 9fcb604ce..0b4fe44db 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -1,3 +1,4 @@ +addin Addin addins Addins diff --git a/man/caching.Rd b/man/caching.Rd index 86c7ceec7..4983dc4c1 100644 --- a/man/caching.Rd +++ b/man/caching.Rd @@ -12,15 +12,15 @@ Code is cached by expression and the cache is shared across all APIs (e.g. } \section{Manage the cache}{ -See \code{\link[=cache_info]{cache_info()}},\code{\link[=cache_deactivate]{cache_deactivate()}} or \code{\link[=cache_clear]{cache_clear()}} for utilities to -manage the cache. You can deactivate it altogether with \code{\link[=cache_activate]{cache_activate()}}. +See \code{\link[=cache_info]{cache_info()}},\code{\link[=cache_activate]{cache_activate()}} or \code{\link[=cache_clear]{cache_clear()}} for utilities to +manage the cache. You can deactivate it altogether with \code{\link[=cache_deactivate]{cache_deactivate()}}. Since we leverage \code{{R.cache}} to manage the cache, you can also use any \code{{R.cache}} functionality to manipulate it. } \section{Interactive setup}{ -styler by default uses caching via the \code{{R.cache}} package. When interacting +\code{{styler}} by default uses caching via the \code{{R.cache}} package. When interacting with \code{{styler}}, you will be asked to let it create a permanent cache on your file system that styler will use in case it is not set already up for another tool that uses \code{{R.cache}}. We encourage users to let \code{{R.cache}} create a @@ -41,7 +41,7 @@ probably give the prompt anyways if called interactively. \section{Non-interactive use}{ Note that if you have never authorized \code{{R.cache}} to create the cache in a -permanent directory and you use styler non-interactively, it will build the +permanent directory and you use \code{{styler}} non-interactively, it will build the cache in a temporary directory. To create a permanent cache, follow the section 'Non-interactive setup' or 'Interactive setup' above. } diff --git a/man/save_after_styling_is_active.Rd b/man/save_after_styling_is_active.Rd new file mode 100644 index 000000000..3199e0b12 --- /dev/null +++ b/man/save_after_styling_is_active.Rd @@ -0,0 +1,13 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/addins.R +\name{save_after_styling_is_active} +\alias{save_after_styling_is_active} +\title{Heuristic to see if a file styled with the addin should be saved or not.} +\usage{ +save_after_styling_is_active() +} +\description{ +Using the R option \code{"styler.save_after_styling"} and if unset, checks legacy +method via environment variable \code{save_after_styling}. +} +\keyword{internal}