doc: add deprecated status to refresh() - fix #49

FRBCesab · Oct 23, 2023 · ef9958b · ef9958b
1 parent 033625f
commit ef9958b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/R/refresh.R b/R/refresh.R
@@ -1,6 +1,8 @@
 #' Refresh a package/research compendium
 #' 
 #' @description 
+#' **This function is about to be removed from `rcompendium`.**
+#' 
 #' This function refreshes a package/research compendium. It will:
 #' * Update `.Rd` files and `NAMESPACE` by using [devtools::document()];
 #' * Update external packages (in `DESCRIPTION` file) by using 
@@ -46,6 +48,8 @@ refresh <- function(compendium = NULL, make = FALSE, check = FALSE,
                     quiet = FALSE) { 
 
 
+  .Deprecated(msg = "This function is about to be removed from 'rcompendium'")
+
   is_package()
 
   stop_if_not_logical(make, check, quiet)

diff --git a/man/refresh.Rd b/man/refresh.Rd