From ed3ac3b58943474c3523d6697379e93ca01e0f87 Mon Sep 17 00:00:00 2001 From: Julia Silge Date: Thu, 9 Nov 2023 11:37:36 -0700 Subject: [PATCH] Clarify that S3-specific arguments are separate from `pin_write()` arguments. Closes #804. --- R/board_s3.R | 5 +++-- man/board_s3.Rd | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/R/board_s3.R b/R/board_s3.R index 40563f34..e5990e5b 100644 --- a/R/board_s3.R +++ b/R/board_s3.R @@ -46,7 +46,8 @@ #' * Some functions like [pin_list()] will work for an S3 board, but don't #' return useful output. #' * You can pass arguments for [paws.storage::s3_put_object] such as `Tagging` -#' and `ServerSideEncryption` through the dots of `pin_write()`. +#' and `ServerSideEncryption` through the dots of `pin_write()`. (Note that +#' these are separate from [pin_write()] arguments like `tags`.) #' * `board_s3()` is powered by the paws.storage package, which is a #' suggested dependency of pins (not required for pins in general). If #' you run into errors when deploying content to a server like @@ -80,7 +81,7 @@ #' board_marketing <- board_s3("company-pins", prefix = "marketing/") #' # You can make the hierarchy arbitrarily deep. #' -#' # Pass arguments like `Tagging` through the dots of `pin_write`: +#' # Pass S3 arguments like `Tagging` through the dots of `pin_write`: #' board %>% pin_write(mtcars, Tagging = "key1=value1&key2=value2") #' #' } diff --git a/man/board_s3.Rd b/man/board_s3.Rd index d7bb4f56..bfdba7d4 100644 --- a/man/board_s3.Rd +++ b/man/board_s3.Rd @@ -87,7 +87,8 @@ a new bucket from R with \link[paws.storage:s3_create_bucket]{paws}. \item Some functions like \code{\link[=pin_list]{pin_list()}} will work for an S3 board, but don't return useful output. \item You can pass arguments for \link[paws.storage:s3_put_object]{paws.storage::s3_put_object} such as \code{Tagging} -and \code{ServerSideEncryption} through the dots of \code{pin_write()}. +and \code{ServerSideEncryption} through the dots of \code{pin_write()}. (Note that +these are separate from \code{\link[=pin_write]{pin_write()}} arguments like \code{tags}.) \item \code{board_s3()} is powered by the paws.storage package, which is a suggested dependency of pins (not required for pins in general). If you run into errors when deploying content to a server like @@ -107,7 +108,7 @@ board_sales <- board_s3("company-pins", prefix = "sales/") board_marketing <- board_s3("company-pins", prefix = "marketing/") # You can make the hierarchy arbitrarily deep. -# Pass arguments like `Tagging` through the dots of `pin_write`: +# Pass S3 arguments like `Tagging` through the dots of `pin_write`: board \%>\% pin_write(mtcars, Tagging = "key1=value1&key2=value2") }