From ef9958b479542b3e222a0f47f27273c6170cca8e Mon Sep 17 00:00:00 2001
From: Nicolas Casajus <nicolas.casajus@gmail.com>
Date: Mon, 23 Oct 2023 09:23:53 +0200
Subject: [PATCH] doc: add deprecated status to refresh() - fix #49

---
 R/refresh.R    | 4 ++++
 man/refresh.Rd | 2 ++
 2 files changed, 6 insertions(+)

diff --git a/R/refresh.R b/R/refresh.R
index f41f25a..162ed30 100644
--- 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
index 3d7568a..305a448 100644
--- a/man/refresh.Rd
+++ b/man/refresh.Rd
@@ -32,6 +32,8 @@ Default is \code{FALSE}.}
 No return value.
 }
 \description{
+\strong{This function is about to be removed from \code{rcompendium}.}
+
 This function refreshes a package/research compendium. It will:
 \itemize{
 \item Update \code{.Rd} files and \code{NAMESPACE} by using \code{\link[devtools:document]{devtools::document()}};