From 6c2a6af06888fd6f17f5e1da126d8ae3c2a557bb Mon Sep 17 00:00:00 2001 From: florisvdh Date: Fri, 15 Dec 2023 08:35:09 +0100 Subject: [PATCH] Internal fn qgis_delete_old_cachefiles(): improve docs --- R/qgis-cache.R | 9 ++++++--- man/qgis_delete_old_cachefiles.Rd | 12 +++++++++--- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/R/qgis-cache.R b/R/qgis-cache.R index c054c954..c3f6907e 100644 --- a/R/qgis-cache.R +++ b/R/qgis-cache.R @@ -21,12 +21,15 @@ qgis_pkgcache_file <- function() { #' #' @param type A string; either `"all"`, `"package"` or `"help"`. #' This selects the type of cache files to delete. -#' @param age_days A number that expresses a cache file's age in days that must -#' be exceeded for it to be deleted, with age referring to its last -#' modification date. +#' @param age_days A number that expresses a cache file's age that must +#' be exceeded for it to be deleted, with age defined as days elapsed since the +#' file's last modification date. #' The default value of 90 days can also be changed with the option #' `qgisprocess.cachefiles_days_keep` or the environment variable #' `R_QGISPROCESS_CACHEFILES_DAYS_KEEP`. +#' @param startup Logical. +#' Is this command being run while loading the package? +#' @inheritParams qgis_path #' #' @keywords internal qgis_delete_old_cachefiles <- function( diff --git a/man/qgis_delete_old_cachefiles.Rd b/man/qgis_delete_old_cachefiles.Rd index 1e3634e6..f30cb014 100644 --- a/man/qgis_delete_old_cachefiles.Rd +++ b/man/qgis_delete_old_cachefiles.Rd @@ -15,12 +15,18 @@ qgis_delete_old_cachefiles( \item{type}{A string; either \code{"all"}, \code{"package"} or \code{"help"}. This selects the type of cache files to delete.} -\item{age_days}{A number that expresses a cache file's age in days that must -be exceeded for it to be deleted, with age referring to its last -modification date. +\item{age_days}{A number that expresses a cache file's age that must +be exceeded for it to be deleted, with age defined as days elapsed since the +file's last modification date. The default value of 90 days can also be changed with the option \code{qgisprocess.cachefiles_days_keep} or the environment variable \code{R_QGISPROCESS_CACHEFILES_DAYS_KEEP}.} + +\item{quiet}{Use \code{FALSE} to display more information, +possibly useful for debugging.} + +\item{startup}{Logical. +Is this command being run while loading the package?} } \description{ Delete old cache files