Internal fn qgis_delete_old_cachefiles(): improve docs

r-spatial · Dec 15, 2023 · 6c2a6af · 6c2a6af
1 parent b7faf2f
commit 6c2a6af
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 6 deletions.
diff --git 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