Skip to content

Commit

Permalink
Document that pins doesn't create a new S3 bucket (#659)
Browse files Browse the repository at this point in the history
* Document that pins doesn't create a new S3 bucket

* Use correct name for `pin_list()`
  • Loading branch information
juliasilge authored Oct 21, 2022
1 parent 5fae5be commit 3d2dc6b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
8 changes: 5 additions & 3 deletions R/board_s3.R
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,15 @@
#'
#' # Details
#'
#' * If you point at a bucket that's not created by pins, some functions
#' like `pins_list()` will work, but won't return useful output.
#' * The functions in pins do not create a new bucket. You can create
#' a new bucket from R with [paws][paws.storage::s3_create_bucket].
#' * 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()`.
#'
#' @inheritParams new_board
#' @param bucket Bucket name.
#' @param bucket Bucket name. You can only write to an existing bucket.
#' @param prefix Prefix within this bucket that this board will occupy.
#' You can use this to maintain multiple independent pin boards within
#' a single S3 bucket. Will typically end with `/` to take advantage of
Expand Down
8 changes: 5 additions & 3 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 3d2dc6b

Please sign in to comment.