From b3fcbd93d4bf9edcb4f82114d642451c3107ee1f Mon Sep 17 00:00:00 2001 From: Julia Silge Date: Wed, 30 Aug 2023 09:53:11 -0600 Subject: [PATCH 1/3] Add documentation for how to clear Connect caches --- R/board_connect.R | 10 +++++++++- man/board_connect.Rd | 8 ++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/R/board_connect.R b/R/board_connect.R index 731a3879..5799cb4a 100644 --- a/R/board_connect.R +++ b/R/board_connect.R @@ -30,8 +30,16 @@ #' )) #' board %>% pin_read("numbers") #' ``` -#' +#' #' You can find the URL of a pin with [pin_browse()]. +#' +#' # Caching on Posit Connect +#' +#' The pins package maintains per-session caches for _users_ and _content_ on +#' your Connect server. If your cache gets into a bad state (for example, user +#' names have changed on the server or a pin was deleted on the server, but +#' your local machine doesn't know about the change yet), you can clear you local +#' cache by restarting your R session. #' #' @inheritParams new_board #' @inheritParams board_url diff --git a/man/board_connect.Rd b/man/board_connect.Rd index f5fb2242..6fc4b18a 100644 --- a/man/board_connect.Rd +++ b/man/board_connect.Rd @@ -104,6 +104,14 @@ board \%>\% pin_read("numbers") You can find the URL of a pin with \code{\link[=pin_browse]{pin_browse()}}. } +\section{Caching on Posit Connect}{ +The pins package maintains per-session caches for \emph{users} and \emph{content} on +your Connect server. If your cache gets into a bad state (for example, user +names have changed on the server or a pin was deleted on the server, but +your local machine doesn't know about the change yet), you can clear you local +cache by restarting your R session. +} + \examples{ \dontrun{ board <- board_connect() From 7ea82c45a12928f19397db37f89b7c398fad2c2b Mon Sep 17 00:00:00 2001 From: Julia Silge Date: Wed, 30 Aug 2023 09:56:09 -0600 Subject: [PATCH 2/3] No whitespace change --- R/board_connect.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/board_connect.R b/R/board_connect.R index 5799cb4a..189e1404 100644 --- a/R/board_connect.R +++ b/R/board_connect.R @@ -32,7 +32,7 @@ #' ``` #' #' You can find the URL of a pin with [pin_browse()]. -#' +#' #' # Caching on Posit Connect #' #' The pins package maintains per-session caches for _users_ and _content_ on From 9dc4a3bdc5ffb1b385d6130177be03f8f0bffeb8 Mon Sep 17 00:00:00 2001 From: Julia Silge Date: Wed, 30 Aug 2023 11:14:53 -0600 Subject: [PATCH 3/3] Be more clear about caching --- R/board_connect.R | 12 ++++++------ man/board_connect.Rd | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/R/board_connect.R b/R/board_connect.R index 189e1404..949f7593 100644 --- a/R/board_connect.R +++ b/R/board_connect.R @@ -33,13 +33,13 @@ #' #' You can find the URL of a pin with [pin_browse()]. #' -#' # Caching on Posit Connect +#' # Local caching for Posit Connect #' -#' The pins package maintains per-session caches for _users_ and _content_ on -#' your Connect server. If your cache gets into a bad state (for example, user -#' names have changed on the server or a pin was deleted on the server, but -#' your local machine doesn't know about the change yet), you can clear you local -#' cache by restarting your R session. +#' The pins package maintains local per-session caches for _users_ and _content_ +#' from your Connect server. If your cache gets into a bad state (for example, +#' user names have changed on the server or a pin was deleted on the server, but +#' your local machine doesn't know about the change yet), you can clear your +#' local cache by restarting your R session. #' #' @inheritParams new_board #' @inheritParams board_url diff --git a/man/board_connect.Rd b/man/board_connect.Rd index 6fc4b18a..0c8592b4 100644 --- a/man/board_connect.Rd +++ b/man/board_connect.Rd @@ -104,12 +104,12 @@ board \%>\% pin_read("numbers") You can find the URL of a pin with \code{\link[=pin_browse]{pin_browse()}}. } -\section{Caching on Posit Connect}{ -The pins package maintains per-session caches for \emph{users} and \emph{content} on -your Connect server. If your cache gets into a bad state (for example, user -names have changed on the server or a pin was deleted on the server, but -your local machine doesn't know about the change yet), you can clear you local -cache by restarting your R session. +\section{Local caching for Posit Connect}{ +The pins package maintains local per-session caches for \emph{users} and \emph{content} +from your Connect server. If your cache gets into a bad state (for example, +user names have changed on the server or a pin was deleted on the server, but +your local machine doesn't know about the change yet), you can clear your +local cache by restarting your R session. } \examples{