Improve documentation about deleting pin versions (#773)

* Improve documentation about deleting pin versions * Update NEWS
rstudio · Aug 31, 2023 · 917303b · 917303b
1 parent 1d15a31
commit 917303b
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -3,8 +3,11 @@
 * Fixed how dots are checked in `pin_write()` to make user-facing messages more 
   clear (#770).
 
+* Improved documentation about Connect caches (#771) and deleting pin versions (#773).
+
 * Added `board_deparse` for `board_url()` (#774).
 
+
 # pins 1.2.1
 
 * New environment variable `PINS_CACHE_DIR` controls the location of the 

diff --git a/R/pin_versions.R b/R/pin_versions.R
@@ -90,7 +90,7 @@ pin_version_delete.pins_board <- function(board, name, version, ...) {
 #' @rdname pin_versions
 #' @param n,days Pick one of `n` or `days` to choose how many versions to
 #'   keep. `n = 3` will keep the last three versions, `days = 14` will
-#'   keep all the versions in the 14 days. Regardless of what values you
+#'   keep all the versions created in the 14 days. Regardless of what values you
 #'   set, `pin_versions_prune()` will never delete the most recent version.
 pin_versions_prune <- function(board, name, n = NULL, days = NULL, ...) {
   versions <- pin_versions(board, name)

diff --git a/man/pin_versions.Rd b/man/pin_versions.Rd
diff --git a/vignettes/pins.Rmd b/vignettes/pins.Rmd
@@ -157,7 +157,7 @@ You can list all the available versions with `pin_versions()`:
 board2 %>% pin_versions("x")
 ```
 
-(Pins does not currently provide any tool to remove old versions, but this is likely to be implemented in the future.)
+You can delete a specific older version with `pin_version_delete()` or sets of older versions with `pin_versions_prune()`.
 
 By default, `pin_read()` will return the most recent version: