Skip to content

Commit

Permalink
Clarify that S3-specific arguments are separate from pin_write() ar…
Browse files Browse the repository at this point in the history
…guments. Closes #804.
  • Loading branch information
juliasilge committed Nov 9, 2023
1 parent 8516d73 commit ed3ac3b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions R/board_s3.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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")
#'
#' }
Expand Down
5 changes: 3 additions & 2 deletions man/board_s3.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ed3ac3b

Please sign in to comment.